htmlspecialchars
特殊文字を HTML エンティティに変換する
&reftitle.description;
stringhtmlspecialchars
stringstring
intflagsENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401
stringnullencoding&null;
booldouble_encode&true;
文字の中には HTML において特殊な意味を持つものがあり、
それらの本来の値を表示したければ
HTML の表現形式に変換してやらなければなりません。
この関数は、これらの変換を行った結果の文字列を返します。
入力文字列の中で名前付きエンティティに関連づけられたものを
すべて変換する必要がある場合には、代わりに
htmlentities
を使用してください。
この関数への入力文字列と最終的なドキュメントとの間で文字セットが一致している場合は、
この関数を使えば HTML ドキュメントに組み込むための準備として十分です。
しかし、この関数への入力の中に、最終的なドキュメントの文字セットでは符号化できない文字がある場合もあります。
そんな文字も (数値エンティティや名前つきエンティティなどで) 残したい場合は、
この関数と htmlentities
(これは、名前付きエンティティに対応する文字しか置換しません)
を使うだけでは不十分です。そんな場合は
mb_encode_numericentity を使う必要があります。
変換対象となる文字
変換前
変換後
& (アンパサンド)
&
" (ダブルクォート)
ENT_NOQUOTES が指定されていない場合、"
' (シングルクォート)
' (ENT_HTML401 の場合) あるいは ' (
ENT_XML1、ENT_XHTML、
ENT_HTML5 の場合)。ただし
ENT_QUOTES が指定されている場合に限る
< (小なり)
<
> (大なり)
>
&reftitle.parameters;
string
変換される文字列。
flags
以下のフラグを組み合わせたビットマスクです。
クォートや無効な符号単位シーケンス、そして文書型の扱いを指定します。
デフォルトは ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401 です。
利用可能な flags 定数
定数名
説明
ENT_COMPAT
ダブルクオートは変換しますがシングルクオートは変換しません。
ENT_QUOTES
シングルクオートとダブルクオートを共に変換します。
ENT_NOQUOTES
シングルクオートとダブルクオートは共に変換されません。
ENT_IGNORE
無効な符号単位シーケンスを含む文字列を渡したときに、
空の文字列を返すのではなく無効な部分を切り捨てるようになります。
このフラグは使わないようにしましょう。
セキュリティの問題が発生する可能性があります。
ENT_SUBSTITUTE
無効な符号単位シーケンスを含む文字列を渡したときに、
空の文字列を返すのではなく Unicode の置換文字に置き換えます。
UTF-8 の場合は U+FFFD、それ以外の場合は � となります。
ENT_DISALLOWED
指定した文書型において無効な符号位置を、Unicode の代替文字である
U+FFFD (UTF-8) あるいは � で置き換えます。
これを設定しなければ、無効な符号位置をそのまま残します。
これは、外部コンテンツを埋め込んだ XML 文書を整形式に保つために有用です。
ENT_HTML401
コードを HTML 4.01 として処理します。
ENT_XML1
コードを XML 1 として処理します。
ENT_XHTML
コードを XHTML として処理します。
ENT_HTML5
コードを HTML 5 として処理します。
encoding
&strings.parameter.encoding;
この関数を使ううえでは
ISO-8859-1 と ISO-8859-15、
UTF-8、cp866、
cp1251、cp1252 そして
KOI8-R は事実上同等です。
string 自体がそのエンコーディングにおける有効な文字列である限り、
これらのエンコーディングでは
htmlspecialchars の影響が及ぶ文字がみな同じ位置にあるからです。
&reference.strings.charsets;
double_encode
double_encode をオフにすると、PHP
は既存の html エンティティをエンコードしません。
デフォルトでは、既存のエンティティも含めてすべてを変換します。
&reftitle.returnvalues;
変換後の文字列を返します。
入力の string の中に
エンコーディング encoding における無効なコードユニットシーケンスが含まれており、
かつ ENT_IGNORE フラグが設定されていなければ、
htmlspecialchars は空文字列を返します。
&reftitle.changelog;
&Version;
&Description;
8.1.0
flags のデフォルト値が
ENT_COMPAT から
ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401
に変更されました。
&reftitle.examples;
htmlspecialchars の例
Test", ENT_QUOTES);
echo $new; // <a href='test'>Test</a>
?>
]]>
&reftitle.notes;
この関数は上記のあげたもの以外に関しては一切の変換を行わないことに注意してください。
すべての変換を行うには
htmlentities を参照ください。
flags の値が曖昧な場合、以下のルールが適用されます:
ENT_COMPAT, ENT_QUOTES,
ENT_NOQUOTES のいずれも存在しない場合、
デフォルトは ENT_NOQUOTES になります。
ENT_COMPAT, ENT_QUOTES,
ENT_NOQUOTES のうちひとつ以上が存在する場合、
ENT_QUOTES がもっとも優先度が高くなり、
その後に ENT_COMPAT が続きます。
ENT_HTML401, ENT_HTML5,
ENT_XHTML,
ENT_XML1 のいずれも存在しなければ、
デフォルトは ENT_HTML401 になります。
ENT_HTML401, ENT_HTML5,
ENT_XHTML,
ENT_XML1 のうちひとつ以上が存在している場合、
ENT_HTML5 が最も優先度が高くなり、
ENT_XHTML,
ENT_XML1 そして ENT_HTML401 の順に続きます。
ENT_DISALLOWED, ENT_IGNORE,
ENT_SUBSTITUTE のうち、ひとつ以上が存在している場合、
ENT_IGNORE の優先度がもっとも高くなり、
ENT_SUBSTITUTE がその後に続きます。
&reftitle.seealso;
get_html_translation_table
htmlspecialchars_decode
strip_tags
htmlentities
nl2br