<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.pcre.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.preg-filter.php',
    1 => 'preg_filter',
    2 => 'Executa pesquisa e substitui&ccedil;&atilde;o usando express&otilde;es regulares',
  ),
  'up' => 
  array (
    0 => 'ref.pcre.php',
    1 => 'Fun&ccedil;&otilde;es da PCRE',
  ),
  'prev' => 
  array (
    0 => 'ref.pcre.php',
    1 => 'Fun&ccedil;&otilde;es da PCRE',
  ),
  'next' => 
  array (
    0 => 'function.preg-grep.php',
    1 => 'preg_grep',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/pcre/functions/preg-filter.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.preg-filter" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">preg_filter</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.3.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">preg_filter</span> &mdash; <span class="dc-title">Executa pesquisa e substituição usando expressões regulares</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.preg-filter-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>preg_filter</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><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.array.php" class="type array">array</a></span></span> <code class="parameter">$pattern</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><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.array.php" class="type array">array</a></span></span> <code class="parameter">$replacement</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><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.array.php" class="type array">array</a></span></span> <code class="parameter">$subject</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">$limit</code><span class="initializer"> = -1</span></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 reference">&$count</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.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.null.php" class="type null">null</a></span></span></div>

  <p class="para rdfs-comment">
   <span class="function"><strong>preg_filter()</strong></span> é idêntica à <span class="function"><a href="function.preg-replace.php" class="function">preg_replace()</a></span>
   exceto que ela somente retorna strings de entrada (possivelmente transformadas) onde ocorreu
   uma correspondência. Para detalhes sobre como esta função trabalha, leia a
   documentação sobre <span class="function"><a href="function.preg-replace.php" class="function">preg_replace()</a></span>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.preg-filter-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   Parâmetros estão descritos na documentação sobre <span class="function"><a href="function.preg-replace.php" class="function">preg_replace()</a></span>.
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.preg-filter-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Retorna um <span class="type"><a href="language.types.array.php" class="type array">array</a></span> se o parâmetro <code class="parameter">subject</code>
   for um <span class="type"><a href="language.types.array.php" class="type array">array</a></span>, ou uma <span class="type"><a href="language.types.string.php" class="type string">string</a></span> caso contrário.
  </p>
  <p class="para">
   Se nenhuma correspondência for encontrada ou se ocorrer um erro, um <span class="type"><a href="language.types.array.php" class="type array">array</a></span> vazio
   é retornado quando <code class="parameter">subject</code> for um <span class="type"><a href="language.types.array.php" class="type array">array</a></span>
   ou <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> caso contrário.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.preg-filter-errors">
  <h3 class="title">Erros/Exceções</h3>
  <p class="para">
Se o padrão de expressão regular passado não for compilado para uma expressão regular válida, um <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong> será emitido.
</p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.preg-filter-examples">
  <h3 class="title">Exemplos</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Exemplo #1 
     Exemplo comparando <span class="function"><strong>preg_filter()</strong></span>
     com <span class="function"><a href="function.preg-replace.php" class="function">preg_replace()</a></span>
    </strong></p>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$subject </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'1'</span><span style="color: #007700">, </span><span style="color: #DD0000">'a'</span><span style="color: #007700">, </span><span style="color: #DD0000">'2'</span><span style="color: #007700">, </span><span style="color: #DD0000">'b'</span><span style="color: #007700">, </span><span style="color: #DD0000">'3'</span><span style="color: #007700">, </span><span style="color: #DD0000">'A'</span><span style="color: #007700">, </span><span style="color: #DD0000">'B'</span><span style="color: #007700">, </span><span style="color: #DD0000">'4'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$pattern </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'/\d/'</span><span style="color: #007700">, </span><span style="color: #DD0000">'/[a-z]/'</span><span style="color: #007700">, </span><span style="color: #DD0000">'/[1a]/'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$replace </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'A:$0'</span><span style="color: #007700">, </span><span style="color: #DD0000">'B:$0'</span><span style="color: #007700">, </span><span style="color: #DD0000">'C:$0'</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"preg_filter retorna\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">preg_filter</span><span style="color: #007700">(</span><span style="color: #0000BB">$pattern</span><span style="color: #007700">, </span><span style="color: #0000BB">$replace</span><span style="color: #007700">, </span><span style="color: #0000BB">$subject</span><span style="color: #007700">));<br /><br />echo </span><span style="color: #DD0000">"preg_replace retorna\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">preg_replace</span><span style="color: #007700">(</span><span style="color: #0000BB">$pattern</span><span style="color: #007700">, </span><span style="color: #0000BB">$replace</span><span style="color: #007700">, </span><span style="color: #0000BB">$subject</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>O exemplo acima produzirá:</p></div>
    <div class="example-contents screen">
<div class="annotation-interactive examplescode"><pre class="examplescode">preg_filter retorna
Array
(
    [0] =&gt; A:C:1
    [1] =&gt; B:C:a
    [2] =&gt; A:2
    [3] =&gt; B:b
    [4] =&gt; A:3
    [7] =&gt; A:4
)
preg_replace retorna
Array
(
    [0] =&gt; A:C:1
    [1] =&gt; B:C:a
    [2] =&gt; A:2
    [3] =&gt; B:b
    [4] =&gt; A:3
    [5] =&gt; A
    [6] =&gt; B
    [7] =&gt; A:4
)</pre>
</div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.preg-filter-seealso">
  <h3 class="title">Veja Também</h3>
  <p class="para">
   <ul class="simplelist">
    <li><a href="pcre.pattern.php" class="link">Expressões regulares PCRE</a></li>
    <li><span class="function"><a href="function.preg-quote.php" class="function" rel="rdfs-seeAlso">preg_quote()</a> - Escapa caracteres de express&atilde;o regular</span></li>
    <li><span class="function"><a href="function.preg-replace.php" class="function" rel="rdfs-seeAlso">preg_replace()</a> - Realiza uma pesquisa por uma express&atilde;o regular e substitui</span></li>
    <li><span class="function"><a href="function.preg-replace-callback.php" class="function" rel="rdfs-seeAlso">preg_replace_callback()</a> - Executa uma busca por express&atilde;o regular e substitui usando uma chamada de retorno</span></li>
    <li><span class="function"><a href="function.preg-grep.php" class="function" rel="rdfs-seeAlso">preg_grep()</a> - Retorna entradas de array que correspondem &agrave; express&atilde;o regular</span></li>
    <li><span class="function"><a href="function.preg-last-error.php" class="function" rel="rdfs-seeAlso">preg_last_error()</a> - Retorna o c&oacute;digo de erro da &uacute;ltima express&atilde;o regular PCRE executada</span></li>
   </ul>
  </p>
 </div>

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