htmlentities

(PHP 4, PHP 5, PHP 7, PHP 8)

htmlentities — 将字符转换为 HTML 转义字符

说明

htmlentities(
    string $string,
    int $flags = ENT_COMPAT | ENT_HTML401,
    string $encoding = ini_get("default_charset"),
    bool $double_encode = true
): string

本函数各方面都和 htmlspecialchars() 一样，除了 htmlentities() 会转换所有具有 HTML 实体的字符。

如果要解码（反向操作），可以使用 html_entity_decode()。

参数

string

输入字符。

flags

以下一组位掩码标记，用于设置如何处理引号、无效代码序列、使用文档的类型。默认是 ENT_COMPAT | ENT_HTML401。

**有效 `flags` 标记常量**
常量名	描述
`ENT_COMPAT`	会转换双引号，不转换单引号。
`ENT_QUOTES`	既转换双引号也转换单引号。
`ENT_NOQUOTES`	单/双引号都不转换
`ENT_IGNORE`	静默丢弃无效的代码单元序列，而不是返回空字符串。不建议使用此标记，因为它» 可能有安全影响。
`ENT_SUBSTITUTE`	替换无效的代码单元序列为 Unicode 代替符（Replacement Character）， U+FFFD (UTF-8) 或者 � (其他)，而不是返回空字符串。
`ENT_DISALLOWED`	为文档的无效代码点替换为 Unicode 代替符（Replacement Character）： U+FFFD (UTF-8)，或 �（其他），而不是把它们留在原处。比如以下情况下就很有用：要保证 XML 文档嵌入额外内容时格式合法。
`ENT_HTML401`	以 HTML 4.01 处理代码。
`ENT_XML1`	以 XML 1 处理代码。
`ENT_XHTML`	以 XHTML 处理代码。
`ENT_HTML5`	以 HTML 5 处理代码。

encoding

An optional argument defining the encoding used when converting characters.

If omitted, encoding defaults to the value of the default_charset configuration option.

Although this argument is technically optional, you are highly encouraged to specify the correct value for your code if the default_charset configuration option may be set incorrectly for the given input.

支持以下字符集：

**支持的字符集列表**
字符集	别名	描述
ISO-8859-1	ISO8859-1	西欧，Latin-1
ISO-8859-5	ISO8859-5	Little used cyrillic charset (Latin/Cyrillic).
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	日语
MacRoman		Mac OS 使用的字符串。
`''`		An empty string activates detection from script encoding (Zend multibyte), default_charset and current locale (see nl_langinfo() and setlocale()), in this order. Not recommended.

注意: 其他字符集没有认可。将会使用默认编码并抛出异常。

double_encode

关闭 double_encode 时，PHP 不会转换现有的 HTML 实体，默认是全部转换。

返回值

返回编码后的字符。

如果指定的编码 encoding 里， string 包含了无效的代码单元序列，没有设置 ENT_IGNORE 或者 ENT_SUBSTITUTE 标记的情况下，会返回空字符串。

更新日志

版本	说明
5.6.0	The default value for the `encoding` parameter was changed to be the value of the default_charset configuration option.
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`。

范例

示例 #1 htmlentities() 例子

<?php 
$str = "A 'quote' is <b>bold</b>";
// 输出: A 'quote' is &lt;
b&gt;
bold&lt;
/b&gt;
echo htmlentities($str);
// 输出: A &#039;
quote&#039;
 is &lt;
b&gt;
bold&lt;
/b&gt;
echo htmlentities($str, ENT_QUOTES);
?>

示例 #2 ENT_IGNORE 用法示例

<?php 
$str = "\x8F!!!";
// 输出空 stringecho htmlentities($str, ENT_QUOTES, "UTF-8");
// 输出 "!!!"echo htmlentities($str, ENT_QUOTES | ENT_IGNORE, "UTF-8");
?>

参见

html_entity_decode() - Convert HTML entities to their corresponding characters
get_html_translation_table() - 返回使用 htmlspecialchars 和 htmlentities 后的转换表
htmlspecialchars() - 将特殊字符转换为 HTML 实体
nl2br() - 在字符串所有新行之前插入 HTML 换行标记
urlencode() - 编码 URL 字符串

PHP（0）