<?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 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.addcslashes.php',
    1 => 'addcslashes',
    2 => 'C 言語と同様にスラッシュで文字列をクォートする',
  ),
  'up' => 
  array (
    0 => 'ref.strings.php',
    1 => 'String 関数',
  ),
  'prev' => 
  array (
    0 => 'ref.strings.php',
    1 => 'String 関数',
  ),
  'next' => 
  array (
    0 => 'function.addslashes.php',
    1 => 'addslashes',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    '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言語と同様の手法によりエスケープされます。
       アスキーコードが32未満または126より大きい文字は、8進表現に変換されます。
      </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>
       また、ある範囲を指定する最初の文字がその範囲の2番目の文字よりも大きな
       ASCII 値を有している場合、範囲は定義されません。
       最初と最後の文字とピリオド文字のみがエスケープされます。
       ある文字の ASCII 値を見つけるには、
       <span class="function"><a href="function.ord.php" class="function">ord()</a></span> 関数を使用してください。
       <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 も例外ではありません。つまり、<code class="parameter">characters</code> にこれらの文字を定義した状態で
       <span class="function"><strong>addcslashes()</strong></span> を使って他の言語のコードを生成したときに、
       期待通りの結果が得られない可能性があるということです。
      </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">
    &quot;\0..\37&quot; のように <code class="parameter">characters</code>
    に範囲を指定可能です。この場合、アスキーコードが 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); ?>