<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.strings.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'function.addcslashes.php',
    1 => 'addcslashes',
    2 => '以 C 语言风格使用反斜线转义字符串中的字符',
  ),
  'up' => 
  array (
    0 => 'ref.strings.php',
    1 => '字符串 函数',
  ),
  'prev' => 
  array (
    0 => 'ref.strings.php',
    1 => '字符串 函数',
  ),
  'next' => 
  array (
    0 => 'function.addslashes.php',
    1 => 'addslashes',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/strings/functions/addcslashes.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.addcslashes" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">addcslashes</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">addcslashes</span> &mdash; <span class="dc-title">以 C 语言风格使用反斜线转义字符串中的字符</span></p>

 </div>
 
  <div class="refsect1 description" id="refsect1-function.addcslashes-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>addcslashes</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$string</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$characters</code></span>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

  <p class="para rdfs-comment">
   返回字符串，该字符串在属于参数 <code class="parameter">characters</code>
   列表中的字符前都加上了反斜线。
  </p>
 </div>

 
 <div class="refsect1 parameters" id="refsect1-function.addcslashes-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">characters</code></dt>
     <dd>
      <p class="para">
       如果 <code class="parameter">characters</code> 中包含有 <code class="literal">\n</code>，<code class="literal">\r</code>
       等字符，将以 C 语言风格转换，而其它非字母数字且 ASCII 码低于 32 以及高于 126 
       的字符均转换成使用八进制表示。
      </p>
      <p class="para">
       当定义 <code class="parameter">characters</code> 参数中的字符序列时，需要确保知道设置为开始及结束范围之内的字符都是什么。
       <div class="example" id="example-1">
        <p><strong>示例 #1 带范围的 <span class="function"><strong>addcslashes()</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 /></span><span style="color: #007700">echo </span><span style="color: #0000BB">addcslashes</span><span style="color: #007700">(</span><span style="color: #DD0000">'foo[ ]'</span><span style="color: #007700">, </span><span style="color: #DD0000">'A..z'</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// 输出：\f\o\o\[ \]<br />// 所有大小写字母均被转义<br />// ... 但 [\]^_` 以及分隔符、换行符、回车符等也一并被转义了。<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
        </div>

       </div>
       另外，如果设置范围中的结束字符 ASCII 
       码高于开始字符，则不会创建范围，只是将开始字符、结束字符以及其间的字符逐个转义。可使用
       <span class="function"><a href="function.ord.php" class="function">ord()</a></span> 函数获取字符的 ASCII 码值。
       <div class="example" id="example-2">
        <p><strong>示例 #2 <span class="function"><strong>addcslashes()</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 /></span><span style="color: #007700">echo </span><span style="color: #0000BB">addcslashes</span><span style="color: #007700">(</span><span style="color: #DD0000">"zoo['.']"</span><span style="color: #007700">, </span><span style="color: #DD0000">'z..A'</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// 输出：\zoo['\.']<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
        </div>

       </div>
      </p>
      <p class="para">
       当选择对字符 0，a，b，f，n，r，t 和 v 进行转义时需要小心。它们将被转换成
       \0，\a，\b，\f，\n，\r，\t 和 \v，这些在 C 中都是预定义的转义序列。其中一些序列也在其它
       C 派生语言（包含 PHP）中定义，这意味着如果使用 <span class="function"><strong>addcslashes()</strong></span>
       和 <code class="parameter">characters</code> 中定义的字符输出生成语言的代码，将不会得到预期的结果。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

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


  <div class="refsect1 examples" id="refsect1-function.addcslashes-examples">
  <h3 class="title">示例</h3>
  <p class="para">
    <code class="parameter">characters</code> 参数，如“\0..\37”，将转义所有
   ASCII 码介于 0 和 31 之间的字符。
   <div class="example" id="example-3">
    <p><strong>示例 #3 <span class="function"><strong>addcslashes()</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 />$not_escaped </span><span style="color: #007700">= </span><span style="color: #DD0000">"PHP isThirty\nYears Old!\tYay to the Elephant!\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$escaped </span><span style="color: #007700">= </span><span style="color: #0000BB">addcslashes</span><span style="color: #007700">(</span><span style="color: #0000BB">$not_escaped</span><span style="color: #007700">, </span><span style="color: #DD0000">"\0..\37!@\177..\377"</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$escaped</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

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


 <div class="refsect1 seealso" id="refsect1-function.addcslashes-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.stripcslashes.php" class="function" rel="rdfs-seeAlso">stripcslashes()</a> - 反引用一个使用 addcslashes 转义的字符串</span></li>
    <li><span class="function"><a href="function.stripslashes.php" class="function" rel="rdfs-seeAlso">stripslashes()</a> - 反引用一个引用字符串</span></li>
    <li><span class="function"><a href="function.addslashes.php" class="function" rel="rdfs-seeAlso">addslashes()</a> - 使用反斜线引用字符串</span></li>
    <li><span class="function"><a href="function.htmlspecialchars.php" class="function" rel="rdfs-seeAlso">htmlspecialchars()</a> - 将特殊字符转换为 HTML 实体</span></li>
    <li><span class="function"><a href="function.quotemeta.php" class="function" rel="rdfs-seeAlso">quotemeta()</a> - 转义元字符集</span></li>
   </ul>
  </p>
 </div>


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