(PHP 4 >= 4.3.0, PHP 5, PHP 7)
html_entity_decode — HTML エンティティを適切な文字に変換する
$string
[, int $flags
= ENT_COMPAT | ENT_HTML401
[, string $encoding
= ini_get("default_charset")
]] )
html_entity_decode() は
htmlentities() の反対で、string
にあるすべての HTML エンティティを適切な文字に変換します。
厳密に言うと、この関数は次の二つの条件を満たすすべての (数値エンティティを含む) エンティティをデコードします。それ以外のエンティティは、何も変換しません。 1) 選択したドキュメントタイプで必然的に有効になるもの。つまり XML の場合には、DTD で定義されている名前付きエンティティはデコードしません。 2) 選択したエンコーディングに関連づけられている符号化文字集合に含まれる文字で、 選択したドキュメントタイプで許可されているもの。
string
入力文字列。
flags
以下のフラグのビットマスクによる組み合わせで、クォートの扱いやドキュメントの形式を指定します。 デフォルトは ENT_COMPAT | ENT_HTML401 です。
定数名 | 説明 |
---|---|
ENT_COMPAT |
ダブルクォートを変換し、シングルクォートはそのままにします。 |
ENT_QUOTES |
ダブルクォート、シングルクォートの両方を変換します。 |
ENT_NOQUOTES |
ダブルクォート、シングルクォートの両方とも変換しません。 |
ENT_HTML401 |
コードを HTML 4.01 として処理します。 |
ENT_XML1 |
コードを XML 1 として処理します。 |
ENT_XHTML |
コードを XHTML として処理します。 |
ENT_HTML5 |
コードを HTML 5 として処理します。 |
encoding
オプションの引数。文字を変換するときに使うエンコーディングを定義します。
省略した場の encoding
のデフォルト値は、varies
PHP のバージョンによって異なります。
PHP 5.6.0 以降では、デフォルト値として default_charset
の値を使います。PHP 5.4 と PHP 5.5 のデフォルト値は、
UTF-8 で、それより前のバージョンの PHP のデフォルト値は
ISO-8859-1 でした。
技術的にはこの引数を省略可能ですが、PHP 5.5 以前のバージョンを使っている場合や、 default_charset の指定が入力とは違う文字セットになっている場合は、 適切な値を指定しておくことを強く推奨します。
以下の文字セットをサポートします。
文字セット | エイリアス | 説明 |
---|---|---|
ISO-8859-1 | ISO8859-1 | 西欧、Latin-1 |
ISO-8859-5 | ISO8859-5 | ほとんど使われないキリル文字セット (Latin/Cyrillic)。 |
ISO-8859-15 | ISO8859-15 | 西欧、Latin-9 。Latin-1(ISO-8859-1) に欠けている ユーロ記号やフランス・フィンランドの文字を追加したもの。 |
UTF-8 | ASCII 互換のマルチバイト 8 ビット Unicode 。 | |
cp866 | ibm866, 866 | DOS 固有のキリル文字セット。 |
cp1251 | Windows-1251, win-1251, 1251 | Windows 固有のキリル文字セット。 |
cp1252 | Windows-1252, 1252 | 西欧のための Windows 固有の文字セット。 |
KOI8-R | koi8-ru, koi8r | ロシア語。 |
BIG5 | 950 | 繁体字中国語。主に台湾で使用されます。 |
GB2312 | 936 | 簡体字中国語。国の標準文字セットです。 |
BIG5-HKSCS | Big5 に香港の拡張を含めたもの。繁体字中国語。 | |
Shift_JIS | SJIS, SJIS-win, cp932, 932 | 日本語。 |
EUC-JP | EUCJP, eucJP-win | 日本語。 |
MacRoman | Mac OS で使われる文字セット。 | |
'' | 空文字列を指定すると、 スクリプトのエンコーディング (Zend multibyte)、 default_charset、 そして現在のロケール (nl_langinfo() および setlocale() を参照ください) の順でエンコーディングを検出します。 この方法はおすすめしません。 |
注意: これら以外の文字セットは理解できません。 かわりにデフォルトのエンコーディングを使用し、警告を発生させます。
デコードされた文字列を返します。
バージョン | 説明 |
---|---|
5.6.0 |
encoding パラメータのデフォルト値が、
default_charset の設定値に変わりました。
|
5.3.3 | デフォルトのエンコーディングが ISO-8859-1 から UTF-8 に変わりました。 |
5.4.0 |
定数 ENT_HTML401 、ENT_XML1 、
ENT_XHTML および ENT_HTML5 が追加されました。
|
例1 HTML エンティティのデコード
<?php
$orig = "I'll \"walk\" the <b>dog</b> now";
$a = htmlentities($orig);
$b = html_entity_decode($a);
echo $a; // I'll "walk" the <b>dog</b> now
echo $b; // I'll "walk" the <b>dog</b> now
?>
注意:
trim(html_entity_decode(' ')); の結果が空の文字列に ならないことを疑問に思う人もいるでしょう。なぜそうなるのかというと、 デフォルトのエンコーディング ISO-8859-1 では ' ' エンティティが ASCII コード 32 (これは trim() で取り除かれる) ではなく ASCII コード 160 (0xa0) に変換されるからです。