htmlentities

(PHP 3, PHP 4, PHP 5)

htmlentities --  適用可能な文字を全てHTMLエンティティに変換する

説明

string htmlentities ( string string [, int quote_style [, string charset [, bool double_encode]]] )

この関数はhtmlspecialchars()と同じですが、 HTML エンティティと等価な意味を有する文字をHTMLエンティティに変換 します。

htmlspecialchars()と同様に、シングルまたは ダブルクオートに関する動作を示すオプションの第2の引数をとります。 これはデフォルトが ENT_COMPAT である 3 つの定数のうちの一つを取ります。

表 1. 利用可能な quote_style 定数

定数名説明
ENT_COMPATダブルクオートのみを変換し、 シングルクオートをそのままにします
ENT_QUOTESダブルおよびシングルクオートを共に変換します
ENT_NOQUOTESダブルクオートおよびシングルクオートを共に変換しません

htmlspecialchars()と同様に、この関数はオプションの3番目の引数 charset をとり、変換に使用される文字セットを指定可能です。 現在のところ、ISO-8859-1 文字セットがデフォルトの文字エンコーディングとして使用されます。

PHP 4.3.0 以降では、以下の文字セットがサポートされます。

表 2. サポートされる文字セット

文字セットエイリアス説明
ISO-8859-1ISO8859-1 西欧、Latin-1
ISO-8859-15ISO8859-15 西欧、Latin-9 。Latin-1(ISO-8859-1) に欠けている ユーロ記号やフランス・フィンランドの文字を追加したもの。
UTF-8  ASCII 互換のマルチバイト 8 ビット Unicode 。
cp866ibm866, 866 DOS 固有のキリル文字セット。 4.3.2 以降でサポートされます。
cp1251Windows-1251, win-1251, 1251 Windows 固有のキリル文字セット。 4.3.2 以降でサポートされます。
cp1252Windows-1252, 1252 西欧のための Windows 固有の文字セット。
KOI8-Rkoi8-ru, koi8r ロシア語。4.3.2 以降でサポートされます。
BIG5950 繁体字中国語。主に台湾で使用されます。
GB2312936 簡体字中国語。国の標準文字セットです。
BIG5-HKSCS  Big5 に香港の拡張を含めたもの。繁体字中国語。
Shift_JISSJIS, 932 日本語。
EUC-JPEUCJP 日本語。

注意: それ以外の文字セットは理解できず、かわりに ISO-8859-1 が使用されます。

double_encode をオフにすると、PHP は既存の html エンティティをエンコードしません。 デフォルトでは、既存のエンティティも含めてすべてを変換します。

double_quote パラメータは PHP 5.2.3 で追加されました。また、 charset は PHP 4.1.0、そして quote は PHP 4.0.3 で追加されました。

もしデコード (逆の処理) をしたい場合、 html_entity_decode() を使用することができます。

例 1. htmlentities() の例

<?php
$str
= "A 'quote' is <b>bold</b>";

// 出力: A 'quote' is &lt;b&gt;bold&lt;/b&gt;
echo htmlentities($str);

// 出力: A &#039;quote&#039; is &lt;b&gt;bold&lt;/b&gt;
echo htmlentities($str, ENT_QUOTES);
?>

html_entity_decode(), get_html_translation_table(), htmlspecialchars(), nl2br(), urlencode() も参照ください。