(PHP 4, PHP 5)
htmlentities — 適用可能な文字を全て HTML エンティティに変換する
$string
[, int $flags = ENT_COMPAT | ENT_HTML401
[, string $encoding = 'UTF-8'
[, bool $double_encode = true
]]] )この関数は htmlspecialchars()と同じですが、 HTML エンティティと等価な意味を有する文字をHTMLエンティティに変換します。
もしデコード (逆の処理) をしたい場合、 html_entity_decode() を使用することができます。
string
入力文字列。
flags
以下のフラグを組み合わせたビットマスクです。 クォートや無効な符号単位シーケンス、そして文書型の扱いを指定します。 デフォルトは ENT_COMPAT | ENT_HTML401 です。
| 定数名 | 説明 |
|---|---|
ENT_COMPAT |
ダブルクオートは変換しますがシングルクオートは変換しません。 |
ENT_QUOTES |
シングルクオートとダブルクオートを共に変換します。 |
ENT_NOQUOTES |
シングルクオートとダブルクオートは共に変換されません。 |
ENT_IGNORE |
無効な符号単位シーケンスを含む文字列を渡したときに、 空の文字列を返すのではなく無効な部分を切り捨てるようになります。 このフラグは使わないようにしましょう。 » セキュリティの問題が発生する可能性があります。 |
ENT_SUBSTITUTE |
無効な符号単位シーケンスを含む文字列を渡したときに、 空の文字列を返すのではなく Unicode の置換文字に置き換えます。 UTF-8 の場合は U+FFFD、それ以外の場合は &#FFFD; となります。 |
ENT_DISALLOWED |
指定した文書型において無効な符号位置を、Unicode の代替文字である U+FFFD (UTF-8) あるいは &#FFFD; で置き換えます。 これを設定しなければ、無効な符号位置をそのまま残します。 これは、外部コンテンツを埋め込んだ XML 文書を整形式に保つために有用です。 |
ENT_HTML401 |
コードを HTML 4.01 として処理します。 |
ENT_XML1 |
コードを XML 1 として処理します。 |
ENT_XHTML |
コードを XHTML として処理します。 |
ENT_HTML5 |
コードを HTML 5 として処理します。 |
encoding
htmlspecialchars()と同様に、 htmlentities() はオプションの3番目の引数
charset をとり、変換に使用されるエンコーディングを指定可能です。
省略した場合のデフォルト値は、PHP 5.4.0 より前のバージョンでは
ISO-8859-1、そして PHP 5.4.0 以降では UTF-8 となります。
この引数は表向きには任意指定となっていますが、コードにあわせて正しい値を指定しておくことを強く推奨します。
以下の文字セットをサポートします。
| 文字セット | エイリアス | 説明 |
|---|---|---|
| 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() を参照ください) の順でエンコーディングを検出します。 この方法はおすすめしません。 |
注意: これら以外の文字セットは理解できません。 かわりにデフォルトのエンコーディングを使用し、警告を発生させます。
double_encode
double_encode をオフにすると、PHP
は既存の html エンティティをエンコードしません。
デフォルトでは、既存のエンティティも含めてすべてを変換します。
エンコードした文字列を返します。
入力文字列の中に、指定した encoding で無効な符号単位シーケンスが含まれる場合は、
ENT_IGNORE あるいは
ENT_SUBSTITUTE フラグが設定されていない限りは空文字列を返します。
| バージョン | 説明 |
|---|---|
| 5.4.0 |
encoding パラメータのデフォルトが
UTF-8 に変わりました。
|
| 5.4.0 |
定数 ENT_SUBSTITUTE、ENT_DISALLOWED、
ENT_HTML401、ENT_XML1、
ENT_XHTML および ENT_HTML5 が追加されました。
|
| 5.3.0 |
定数 ENT_IGNORE が追加されました。
|
| 5.2.3 |
double_encode パラメータが追加されました。
|
| 4.1.0 |
encoding パラメータが追加されました。
|
| 4.0.3 |
flags パラメータが追加されました。
|
例1 htmlentities() の例
<?php
$str = "A 'quote' is <b>bold</b>";
// 出力: A 'quote' is <b>bold</b>
echo htmlentities($str);
// 出力: A 'quote' is <b>bold</b>
echo htmlentities($str, ENT_QUOTES);
?>
例2 ENT_IGNORE の使用例
<?php
$str = "\x8F!!!";
// 出力: 空の文字列
echo htmlentities($str, ENT_QUOTES, "UTF-8");
// 出力: "!!!"
echo htmlentities($str, ENT_QUOTES | ENT_IGNORE, "UTF-8");
?>