<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.iconv.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.iconv-substr.php',
    1 => 'iconv_substr',
    2 => '文字列の一部を切り出す',
  ),
  'up' => 
  array (
    0 => 'ref.iconv.php',
    1 => 'iconv 関数',
  ),
  'prev' => 
  array (
    0 => 'function.iconv-strrpos.php',
    1 => 'iconv_strrpos',
  ),
  'next' => 
  array (
    0 => 'function.ob-iconv-handler.php',
    1 => 'ob_iconv_handler',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/iconv/functions/iconv-substr.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.iconv-substr" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">iconv_substr</h1>
  <p class="verinfo">(PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">iconv_substr</span> &mdash; <span class="dc-title">文字列の一部を切り出す</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-function.iconv-substr-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>iconv_substr</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$string</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$offset</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></span> <code class="parameter">$length</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$encoding</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span><br>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   文字列 <code class="parameter">string</code> の、
   <code class="parameter">offset</code> と <code class="parameter">length</code>
   で指定された一部を返します。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.iconv-substr-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">string</code></dt>
     <dd>
      <p class="para">
       元の文字列。
      </p>
     </dd>
    
    
     <dt><code class="parameter">offset</code></dt>
     <dd>
      <p class="para">
       <code class="parameter">offset</code> が負でない場合、
       <span class="function"><strong>iconv_substr()</strong></span> は
       <code class="parameter">string</code> の <code class="parameter">offset</code>
       番目の文字（ゼロから数えて）から切り出します。
      </p>
      <p class="para">
       <code class="parameter">offset</code> が負の場合、
       <span class="function"><strong>iconv_substr()</strong></span> は
       <code class="parameter">string</code> の最後から数えて
       <code class="parameter">offset</code> 番目の文字から切り出します。
      </p>
     </dd>
    
    
     <dt><code class="parameter">length</code></dt>
     <dd>
      <p class="para">
       <code class="parameter">length</code> が指定され、かつ正である場合、
       返される文字列は <code class="parameter">offset</code>
       から数えて最大 <code class="parameter">length</code> 文字数分となります
       (<code class="parameter">string</code> の長さに依存します)。
      </p>
      <p class="para">
       もし負の <code class="parameter">length</code> が渡された場合に
       <span class="function"><strong>iconv_substr()</strong></span> が切り出す文字列は、
       <code class="parameter">string</code> の <code class="parameter">offset</code>
       番目の文字からはじまり、文字列の最後から数えて
       <code class="parameter">length</code> 文字分戻ったところまでとなります。
       <code class="parameter">offset</code> も負の場合、開始位置は
       上で説明した方式で計算されます。
      </p>
     </dd>
    
    
     <dt><code class="parameter">encoding</code></dt>
     <dd>
      <p class="para">
       <code class="parameter">encoding</code> が指定されなかった場合、もしくは <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> の場合、文字セットは
       ini 設定 <a href="iconv.configuration.php" class="link">iconv.internal_encoding</a>
       で定義された値とみなされます。
      </p>
      <p class="para">
       <code class="parameter">offset</code> や <code class="parameter">length</code>
       のパラメータは、常に <code class="parameter">charset</code> で定義された
       文字セットにおける文字数と判断されることに注意してください。
       一方、<span class="function"><a href="function.substr.php" class="function">substr()</a></span> の場合はこれらの値を常に
       バイト数として判断します。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.iconv-substr-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   文字列 <code class="parameter">string</code> の、
   <code class="parameter">offset</code> と <code class="parameter">length</code>
   で指定された一部を返します。
  </p>
  <p class="para">
   もし <code class="parameter">string</code> が <code class="parameter">offset</code>
   の文字列長より短い場合は、<strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> が返されます。
   <code class="parameter">string</code> が 
   <code class="parameter">offset</code> の文字数に等しい場合、
   空文字列が返されます。
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.iconv-substr-changelog">
  <h3 class="title">変更履歴</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>バージョン</th>
       <th>説明</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>8.0.0</td>
       <td>
        <code class="parameter">length</code> と <code class="parameter">encoding</code> は、nullable になりました。
       </td>
      </tr>

      <tr>
       <td>7.0.11</td>
       <td>
        <code class="parameter">string</code> が 
        <code class="parameter">offset</code> の文字数に等しい場合、
        空文字列が返されます。
        これより前のバージョンでは、この場合 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> が返されていました。
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.iconv-substr-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.substr.php" class="function" rel="rdfs-seeAlso">substr()</a> - 文字列の一部分を返す</span></li>
    <li><span class="function"><a href="function.mb-substr.php" class="function" rel="rdfs-seeAlso">mb_substr()</a> - 文字列の一部を得る</span></li>
    <li><span class="function"><a href="function.mb-strcut.php" class="function" rel="rdfs-seeAlso">mb_strcut()</a> - 文字列の一部を得る</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>