php htmlentities 文字列をHTMLエンティティにエンコード
PHP4 PHP5 PHP7
php htmlentities 文字列をHTMLエンティティにエンコード
htmlentities() 書式
string 文字列 = htmlentities('string $string' [, int $flags = ENT_COMPAT | ENT_HTML401 [, string $encoding = ini_get(“default_charset”) [, bool $double_encode = TRUE ]]]);
返り値は文字列(string)
//[ ]省略可
string 文字列 = htmlentities('string $string' [, int $flags = ENT_COMPAT | ENT_HTML401 [, string $encoding = ini_get(“default_charset”) [, bool $double_encode = TRUE ]]]);
返り値は文字列(string)
//[ ]省略可
説明 | 文字列をHTMLエンティティにエンコードします。 | |
---|---|---|
引数 | string $str | 入力文字列(テキスト) |
返り値 | string 文字列 | HTMLエンティティにエンコードした文字列を返します。 |
サンプル
1 2 3 4 5 | <?php $string = '<strong>太字</strong>'; echo 'そのまま出力 : '.$string."<br>\n"; echo 'HTMLエンティティ : '.htmlentities($string, ENT_QUOTES, 'UTF-8')."<br>\n"; ?> |
そのまま出力 : 太字
HTMLエンティティ : <strong>太字</strong>
HTMLエンティティ : <strong>太字</strong>
◆ 引数 や 返り値 のデータ型の説明
データ型 引数 や 返り値 のデータ型の説明引数 や 返り値 | 内容(引数 | 返り値) |
---|---|
string | 文字列型 を受け入れる。 | 文字列型 を返す。 |
int | 整数型 を受け入れる。 | 整数型 を返す。 |
float | 浮動小数点数型 を受け入れる。 | 浮動小数点数型 を返す。 |
bool | 論理型 を受け入れる。 | 論理型 を返す。 |
number | 整数型 または 浮動小数点数型 を受け入れる。 | 整数型 または 浮動小数点数型 を返す。 |
array | 配列型 を受け入れる。 | 配列型 を返す。 |
object | オブジェクト型 を受け入れる。 | オブジェクト型 を返す。 |
array|object | 配列型 または オブジェクト型 を受け入れる。 | 配列型 または オブジェクト型 を返す。 |
mixed | 複数の データ型 を受け入れる(パラメーター)、或いは、返す(返り値)ことが可能。全てのデータ型ではありません。例えば gettype()関数 は全ての型を受け入れますが、一方、str_replace()関数 は、文字列型 と 配列型 のみを受け入れます。また、reset()関数 や end()関数 は、返り値に 配列型 と 論理型(FALSE)を返します。 |
void | パラメータ一覧で void が使用されている場合、その関数がパラメータを受け付けないことを表します。 | 返り値の型が void である場合、返り値に意味がないことを表します。 |
callback | callback 疑似型がこのドキュメントで使われていたのは、PHP 5.4 で callable タイプヒントが導入される前のことでした。両者はまったく同じ意味です。 |
◆ htmlentities() 内容
HTMLエンティティにエンコード
文字列をHTMLエンティティにエンコードします。この関数は htmlspecialchars()と同じですが、 HTMLエンティティと等価な意味を有する文字をHTMLエンティティに変換します。
HTMLエンティティとは、「"(ダブルクォート)」、「'(シングルクォート)」、「<(大なり記号)」、「>(小なり記号)」など、HTMLタグ文字として使用されている「HTML特殊文字」をHTML上で表示できる文字に変換されたもののことです。
1 2 3 4 | < → < //HTMLエンティティ > → > //HTMLエンティティ " → " //HTMLエンティティ ' → ' //HTMLエンティティ |
◆ htmlentities() パラメーター
値 | 内容 |
---|---|
string $string | エンコードする文字列。 |
int $flags | エンコードの処理を指定します。デフォルトは ENT_COMPAT | ENT_HTML401 です。 |
string $encoding | エンコーディングを指定します。 省略した場合、string $encoding のデフォルト値は、PHPのバージョンによって異なります。PHP 5.6.0 以降では、デフォルト値として default_charset の値を使います。PHP 5.4 と PHP 5.5 のデフォルト値は、 UTF-8 で、それより前のバージョンの PHP のデフォルト値は ISO-8859-1 です。 |
bool $double_encode | bool $double_encode をオフにすると、PHP は既存の html エンティティをエンコードしません。 デフォルトでは、既存のエンティティも含めてすべてを変換します。 |
利用可能な int $flags 定数
定数名 | 説明 |
---|---|
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 として処理します。 |
サポートする文字セット
文字セット | エイリアス | 説明 |
---|---|---|
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() を参照ください) の順でエンコーディングを検出します。 この方法はおすすめしません。 |
◆ htmlentities() 返り値
string
HTMLエンティティにエンコードした文字列を返します。
string 文字列型を返します。
◆ htmlentities() 変更履歴
PHPバージョン | 変更内容 |
---|---|
5.6.0 | string $encoding パラメータのデフォルト値が、 default_charset の設定値に変わりました。 |
5.4.0 | string $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 | bool $double_encode パラメータが追加されました。 |
php htmlentities() サンプル
サンプル
1 2 3 4 | $string = '<a href="https://wepicks.net/">wepicks</a>'; echo 'そのまま出力 : '.$string."<br>\n"; echo 'HTMLエンティティ : '.htmlentities($string, ENT_QUOTES, 'UTF-8')."<br>\n"; ?> |
実行結果
そのまま出力 : wepicks
HTMLエンティティ : <a href="https://wepicks.net/">wepicks</a>
HTMLエンティティ : <a href="https://wepicks.net/">wepicks</a>
タグ(=記事関連ワード)
タグ: htmlentities, PHP, 関数
日付
投稿日:2019年7月2日
最終更新日:2019年11月10日
最終更新日:2019年11月10日
このカテゴリの他のページ
この記事へのコメント
トラックバックurl
https://wepicks.net/phpfunction-string-htmlentities/trackback/