<?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 => 'zh',
  ),
  'this' => 
  array (
    0 => 'function.preg-quote.php',
    1 => 'preg_quote',
    2 => '转义正则表达式字符',
  ),
  'up' => 
  array (
    0 => 'ref.pcre.php',
    1 => 'PCRE 函数',
  ),
  'prev' => 
  array (
    0 => 'function.preg-match-all.php',
    1 => 'preg_match_all',
  ),
  'next' => 
  array (
    0 => 'function.preg-replace.php',
    1 => 'preg_replace',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/pcre/functions/preg-quote.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.preg-quote" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">preg_quote</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">preg_quote</span> &mdash; <span class="dc-title">转义正则表达式字符</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.preg-quote-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>preg_quote</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$str</code></span>, <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">$delimiter</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

  <p class="para rdfs-comment">
  <span class="function"><strong>preg_quote()</strong></span>需要参数 <code class="parameter">str</code> 并向其中
  每个正则表达式语法中的字符前增加一个反斜线。 这通常用于你有一些运行时字符串
  需要作为正则表达式进行匹配的时候。
  </p>
  <p class="para">
   正则表达式特殊字符有：
   <code class="literal">. \ + * ? [ ^ ] $ ( ) { } = ! &lt; &gt; | : - #</code>
  </p>
  <p class="para">
   注意 <code class="literal">/</code> 不是正则表达式特殊字符。
  </p>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <p class="para">
    注意：<span class="function"><strong>preg_quote()</strong></span> 的应用场景不是用于 <span class="function"><a href="function.preg-replace.php" class="function">preg_replace()</a></span> 的 $replacement  字符串参数。
   </p>
  </p></blockquote>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.preg-quote-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">str</code></dt>
     <dd>
      <p class="para">
       输入字符串
      </p>
     </dd>
    
    
     <dt><code class="parameter">delimiter</code></dt>
     <dd>
      <p class="para">
      如果指定了可选参数 <code class="parameter">delimiter</code>，它也会被转义。这通常用于
      转义PCRE函数使用的分隔符。 <code class="literal">/</code> 是最常见的分隔符。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.preg-quote-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   返回转义后的字符串。
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.preg-quote-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>7.3.0</td>
       <td>
        字符 <code class="literal">#</code> 被增加为需要转义的。
       </td>
      </tr>

      <tr>
       <td>7.2.0</td>
       <td>
        <code class="parameter">delimiter</code> 现在可为 null。
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.preg-quote-examples">
  <h3 class="title">示例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>示例 #1 <span class="function"><strong>preg_quote()</strong></span>示例</strong></p>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$keywords </span><span style="color: #007700">= </span><span style="color: #DD0000">'$40 for a g3/400'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$keywords </span><span style="color: #007700">= </span><span style="color: #0000BB">preg_quote</span><span style="color: #007700">(</span><span style="color: #0000BB">$keywords</span><span style="color: #007700">, </span><span style="color: #DD0000">'/'</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$keywords</span><span style="color: #007700">; </span><span style="color: #FF8000">// 返回 \$40 for a g3\/400<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
  <p class="para">
   <div class="example" id="example-2">
    <p><strong>示例 #2 将文本中的单词替换为斜体</strong></p>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">//在这个例子中，preg_quote($word) 用于保持星号原文涵义，使其不使用正则表达式中的特殊语义。<br /><br /></span><span style="color: #0000BB">$textbody </span><span style="color: #007700">= </span><span style="color: #DD0000">"This book is *very* difficult to find."</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$word </span><span style="color: #007700">= </span><span style="color: #DD0000">"*very*"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$textbody </span><span style="color: #007700">= </span><span style="color: #0000BB">preg_replace </span><span style="color: #007700">(</span><span style="color: #DD0000">"/" </span><span style="color: #007700">. </span><span style="color: #0000BB">preg_quote</span><span style="color: #007700">(</span><span style="color: #0000BB">$word</span><span style="color: #007700">, </span><span style="color: #DD0000">'/'</span><span style="color: #007700">) . </span><span style="color: #DD0000">"/"</span><span style="color: #007700">,<br />                          </span><span style="color: #DD0000">"&lt;i&gt;" </span><span style="color: #007700">. </span><span style="color: #0000BB">$word </span><span style="color: #007700">. </span><span style="color: #DD0000">"&lt;/i&gt;"</span><span style="color: #007700">,<br />                          </span><span style="color: #0000BB">$textbody</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-function.preg-quote-notes">
  <h3 class="title">注释</h3>
  <blockquote class="note"><p><strong class="note">注意</strong>: <span class="simpara">此函数可安全用于二进制对象。</span></p></blockquote>
 </div>


  <div class="refsect1 seealso" id="refsect1-function.preg-quote-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li><a href="pcre.pattern.php" class="link">PCRE 模式</a></li>
    <li><span class="function"><a href="function.escapeshellcmd.php" class="function" rel="rdfs-seeAlso">escapeshellcmd()</a> - shell 元字符转义</span></li>
   </ul>
  </p>
 </div>

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