<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.intl.grapheme.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.grapheme-substr.php',
    1 => 'grapheme_substr',
    2 => 'Retorna parte de uma string',
  ),
  'up' => 
  array (
    0 => 'ref.intl.grapheme.php',
    1 => 'Fun&ccedil;&otilde;es de Grapheme',
  ),
  'prev' => 
  array (
    0 => 'function.grapheme-strstr.php',
    1 => 'grapheme_strstr',
  ),
  'next' => 
  array (
    0 => 'ref.intl.idn.php',
    1 => 'Fun&ccedil;&otilde;es de IDN',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/intl/grapheme/grapheme-substr.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.grapheme-substr" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">grapheme_substr</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.3.0, PHP 7, PHP 8, PECL intl &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">grapheme_substr</span> &mdash; <span class="dc-title">Retorna parte de uma string</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.grapheme-substr-description">
  <h3 class="title">Descrição</h3>
  <p class="para">Estilo procedural</p>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>grapheme_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"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$locale</code><span class="initializer"> = &quot;&quot;</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">
   Retorna parte de uma string.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.grapheme-substr-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">string</code></dt>
     <dd>
      <p class="para">
       A string de entrada. Deve ser em UTF-8 válido.
      </p>
     </dd>
    
    
     <dt><code class="parameter">offset</code></dt>
     <dd>
      <p class="para">
       Posição de início em unidades padrão de grafema.
       Se <code class="parameter">offset</code> for não negativo, a string retornada iniciará na posição
       <code class="parameter">offset</code> da <code class="parameter">string</code>, contando a partir de zero. Se <code class="parameter">offset</code> for negativo,
       a string retornada iniciará no posição <code class="parameter">offset</code> em unidades de grafema contada a partir
       do final da string.
      </p>
     </dd>
    
    
     <dt><code class="parameter">length</code></dt>
     <dd>
      <p class="para">
       Comprimento em unidades de grafema.
       Se <code class="parameter">length</code> for informado e positivo, a string retornada conterá,
       no máximo, a quantidade de grafemas informada em <code class="parameter">length</code>, iniciando de <code class="parameter">offset</code> (dependendo do
       comprimento da string). Se <code class="parameter">length</code> for informado e negativo,
       representará as unidades de grafema que serão omitidas no final da string (depois da
       posição de início calculada quando <code class="parameter">offset</code> é negativo). Se <code class="parameter">offset</code>
       denotar uma posição além deste truncamento, uma string vazia será retornada.
      </p>
     </dd>
    
    
     <dt><code class="parameter">locale</code></dt>
     <dd>
      <span class="simpara">Localidade a ser usada.</span>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.grapheme-substr-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Retorna a parte extraída da <code class="parameter">string</code>,  ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> em caso de falha.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.grapheme-substr-changelog">
  <h3 class="title">Registro de Alterações</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Versão</th>
      <th>Descrição</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
 <td>8.5.0</td>
 <td>
  O parâmetro opcional <code class="parameter">locale</code> foi adicionado.
 </td>
</tr>

     <tr>
      <td>8.0.0</td>
      <td>
       A função agora fixa consistentemente deslocamentos fora dos limites ao limite da string.
       Anteriormente, <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> era retornado em vez da string vazia em alguns casos.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.grapheme-substr-examples">
  <h3 class="title">Exemplos</h3>
  <div class="example" id="example-1">
   <p><strong>Exemplo #1 Exemplo de <span class="function"><strong>grapheme_substr()</strong></span></strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />$char_a_ring_nfd </span><span style="color: #007700">= </span><span style="color: #DD0000">"a\xCC\x8A"</span><span style="color: #007700">;  </span><span style="color: #FF8000">// 'LATIN SMALL LETTER A WITH RING ABOVE' (U+00E5) NFD<br /></span><span style="color: #0000BB">$char_o_diaeresis_nfd </span><span style="color: #007700">= </span><span style="color: #DD0000">"o\xCC\x88"</span><span style="color: #007700">; </span><span style="color: #FF8000">// 'LATIN SMALL LETTER O WITH DIAERESIS' (U+00F6) NFD<br /><br /></span><span style="color: #007700">print </span><span style="color: #0000BB">urlencode</span><span style="color: #007700">(</span><span style="color: #0000BB">grapheme_substr</span><span style="color: #007700">( </span><span style="color: #DD0000">"ao" </span><span style="color: #007700">. </span><span style="color: #0000BB">$char_a_ring_nfd </span><span style="color: #007700">. </span><span style="color: #DD0000">"bc" </span><span style="color: #007700">. </span><span style="color: #0000BB">$char_o_diaeresis_nfd </span><span style="color: #007700">. </span><span style="color: #DD0000">"O"</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">, -</span><span style="color: #0000BB">1 </span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
  <p class="para">O exemplo acima produzirá:</p>
  <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">a%CC%8Abco%CC%88</pre>
</div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.grapheme-substr-seealso">
  <h3 class="title">Veja Também</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.grapheme-extract.php" class="function" rel="rdfs-seeAlso">grapheme_extract()</a> - Extrai uma sequ&ecirc;ncia de grupos padr&atilde;o de grafemas de um buffer de texto em UTF-8</span></li>
    <li>
     <a href="http://unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries" class="link external">&raquo;&nbsp;
      Segmentação de texto Unicode: limites do cluster de grafema (em inglês)
     </a>
    </li>
   </ul>
  </p>
 </div>

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