htmlentities.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 06394ea77c2f8972e3884c00bede861ef5eb04da Maintainer: takagi Status: ready -->
<!-- CREDITS: hirokawa,shimooka,mumumu -->
<refentry xml:id="function.htmlentities" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>htmlentities</refname>
  <refpurpose>適用可能な文字を全て HTML エンティティに変換する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>htmlentities</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>double_encode</parameter><initializer>&true;</initializer></methodparam>
  </methodsynopsis>
  <para>
   この関数は<function>htmlspecialchars</function>と同じですが、
   HTML エンティティと等価な意味を有する文字をHTMLエンティティに変換します。
   指定する <parameter>flags</parameter>
   定数に応じて使われる変換テーブルを得るには、
   <function>get_html_translation_table</function> を使います。
  </para>
  <para>
   もしデコード (逆の処理) をしたい場合、
   <function>html_entity_decode</function> を使用することができます。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       入力文字列。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       以下のフラグを組み合わせたビットマスクです。
       クォートや無効な符号単位シーケンス、そして文書型の扱いを指定します。
       デフォルトは <literal>ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401</literal> です。
       <table>
        <title>利用可能な <parameter>flags</parameter> 定数</title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>定数名</entry>
           <entry>説明</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><constant>ENT_COMPAT</constant></entry>
           <entry>ダブルクオートは変換しますがシングルクオートは変換しません。</entry>
          </row>
          <row>
           <entry><constant>ENT_QUOTES</constant></entry>
           <entry>シングルクオートとダブルクオートを共に変換します。</entry>
          </row>
          <row>
           <entry><constant>ENT_NOQUOTES</constant></entry>
           <entry>シングルクオートとダブルクオートは共に変換されません。</entry>
          </row>
          <row>
           <entry><constant>ENT_IGNORE</constant></entry>
           <entry>
            無効な符号単位シーケンスを含む文字列を渡したときに、
            空の文字列を返すのではなく無効な部分を切り捨てるようになります。
            このフラグは使わないようにしましょう。
            <link xlink:href="&url.delete.nonchars;">セキュリティの問題が発生する可能性があります</link>。
           </entry>
          </row>
          <row>
           <entry><constant>ENT_SUBSTITUTE</constant></entry>
           <entry>
            無効な符号単位シーケンスを含む文字列を渡したときに、
            空の文字列を返すのではなく Unicode の置換文字に置き換えます。
            UTF-8 の場合は U+FFFD、それ以外の場合は &amp;#FFFD; となります。
           </entry>
          </row>
          <row>
           <entry><constant>ENT_DISALLOWED</constant></entry>
           <entry>
            指定した文書型において無効な符号位置を、Unicode の代替文字である
            U+FFFD (UTF-8) あるいは &amp;#FFFD; で置き換えます。
            これを設定しなければ、無効な符号位置をそのまま残します。
            これは、外部コンテンツを埋め込んだ XML 文書を整形式に保つために有用です。
           </entry>
          </row>
          <row>
           <entry><constant>ENT_HTML401</constant></entry>
           <entry>
            コードを HTML 4.01 として処理します。
           </entry>
          </row>
          <row>
           <entry><constant>ENT_XML1</constant></entry>
           <entry>
            コードを XML 1 として処理します。
           </entry>
          </row>
          <row>
           <entry><constant>ENT_XHTML</constant></entry>
           <entry>
            コードを XHTML として処理します。
           </entry>
          </row>
          <row>
           <entry><constant>ENT_HTML5</constant></entry>
           <entry>
            コードを HTML 5 として処理します。
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encoding</parameter></term>
     <listitem>
      &strings.parameter.encoding;
      &reference.strings.charsets;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>double_encode</parameter></term>
     <listitem>
      <para>
       <parameter>double_encode</parameter> をオフにすると、PHP
       は既存の html エンティティをエンコードしません。
       デフォルトでは、既存のエンティティも含めてすべてを変換します。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   エンコードした文字列を返します。
  </para>
  <para>
   入力文字列の中に、指定した <parameter>encoding</parameter> で無効な符号単位シーケンスが含まれる場合は、
   <constant>ENT_IGNORE</constant> あるいは
   <constant>ENT_SUBSTITUTE</constant> フラグが設定されていない限りは空文字列を返します。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.1.0</entry>
      <entry>
       <parameter>flags</parameter> のデフォルト値が
       <constant>ENT_COMPAT</constant> から
       <constant>ENT_QUOTES</constant> | <constant>ENT_SUBSTITUTE</constant> | <constant>ENT_HTML401</constant>
       に変更されました。
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>encoding</parameter> は、nullable になりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>htmlentities</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$str = "A 'quote' is <b>bold</b>";

echo htmlentities($str);
echo "\n\n";
echo htmlentities($str, ENT_COMPAT);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
A &#039;quote&#039; is &lt;b&gt;bold&lt;/b&gt;

A 'quote' is &lt;b&gt;bold&lt;/b&gt
]]>
    </screen>
   </example>
  </para>
  
  <para>
   <example>
    <title><constant>ENT_IGNORE</constant> の使用例</title>
    <programlisting role="php">
<![CDATA[
<?php
$str = "\x8F!!!";

// 出力: 空の文字列
echo htmlentities($str, ENT_QUOTES, "UTF-8");

// 出力: "!!!"
echo htmlentities($str, ENT_QUOTES | ENT_IGNORE, "UTF-8");
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>html_entity_decode</function></member>
    <member><function>get_html_translation_table</function></member>
    <member><function>htmlspecialchars</function></member>
    <member><function>nl2br</function></member>
    <member><function>urlencode</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->