パラメータ

string

入力文字列。

flags

htmlspecialchars() と同様に、シングルまたは ダブルクオートに関する動作を示すオプションの第2の引数をとります。 これは 3 つの定数のうちの一つとなり、 デフォルトは ENT_COMPAT です。 また、PHP 5.3.0 以降では、これらを第 4 の定数 ENT_IGNORE と組み合わせることもできます。

利用可能な flags 定数

定数名	説明
ENT_COMPAT	ダブルクオートのみを変換し、 シングルクオートをそのままにします
ENT_QUOTES	ダブルおよびシングルクオートを共に変換します
ENT_NOQUOTES	ダブルクオートおよびシングルクオートを共に変換しません
ENT_IGNORE	無効なコードシーケンスが含まれる文字列を渡した場合に、 空の文字列を返すのではなく無効な部分を切り捨てます。 PHP 5.3.0 で追加されました。 これは、過去との互換性を確保するために用意されているものです。 セキュリティの問題があるので、使わないようにしましょう。

charset

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

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

サポートする文字セット

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

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

double_encode

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