上一节:
下一节:

  PHP htmlspecialchars 字符串函数

  • 定义和用法

    htmlspecialchars - 将特殊字符转换为 HTML 实体

  • 版本支持

    PHP4 PHP5 PHP7
    支持 支持 支持

  • 语法

    htmlspecialchars (string $string [, int $flags = ENT_COMPAT | ENT_HTML401 [, string $encoding = ini_get("default_charset") [, bool $double_encode = TRUE ]]])
    某类字符在 HTML 中有特殊用处，如需保持原意，需要用 HTML 实体来表达。 本函数会返回字符转义后的表达。 如需转换子字符串中所有关联的名称实体，使用 htmlentities() 代替本函数。如果传入字符的字符编码和最终的文档是一致的，则用函数处理的输入适合绝大多数 HTML 文档环境。 然而，如果输入的字符编码和最终包含字符的文档是不一样的， 想要保留字符（以数字或名称实体的形式），本函数以及 htmlentities() （仅编码名称实体对应的子字符串）可能不够用。 这种情况可以使用 mb_encode_numericentity() 代替。
    字符 替换后
    & (& 符号) &
    " (双引号) "，除非设置了 ENT_NOQUOTES
    ' (单引号) 设置了 ENT_QUOTES 后， ' (如果是 ENT_HTML401) ，或者 ' (如果是 ENT_XML1、 ENT_XHTML 或 ENT_HTML5)。
    < (小于) &lt;
    > (大于) &gt;

  • 参数

    参数 必需的 描述
    string 是 待转换的字符串
    flags 否 以下一个或多个标志的位掩码，指定如何处理引号以及要使用的文档类型。 默认为ENT_COMPAT | ENT_HTML401。
    • ENT_COMPAT 将转换双引号并单独留下单引号。
    • ENT_QUOTES 将转换双引号和单引号。
    • ENT_NOQUOTES 将双引号和单引号保留为未转换。
    • ENT_IGNORE 静默丢弃无效的代码单元序列，而不是返回空字符串。 不建议使用此标记， 因为它» 可能有安全影响。
    • ENT_SUBSTITUTE 替换无效的代码单元序列为 Unicode 代替符（Replacement Character）， U+FFFD (UTF-8) 或者 &#xFFFD; (其他)，而不是返回空字符串。
    • ENT_DISALLOWED 为文档的无效代码点替换为 Unicode 代替符（Replacement Character）： U+FFFD (UTF-8)，或 &#xFFFD;（其他），而不是把它们留在原处。 比如以下情况下就很有用：要保证 XML 文档嵌入额外内容时格式合法。
    • ENT_HTML401 将代码处理为HTML 4.01。
    • ENT_XML1 将代码处理为XML 1。
    • ENT_XHTML 将代码处理为XHTML。
    • ENT_HTML5 将代码处理为HTML 5。
    encoding 否 定义转换字符时使用的编码的可选参数。如果省略，编码的默认值将根据使用的PHP版本而变化。在php 5.6及更高版本中，默认的_charset配置选项用作默认值。php 5.4和5.5将使用utf-8作为默认值。PHP的早期版本使用ISO-8859-1。尽管此参数在技术上是可选的，但是如果您使用的是php 5.5或更早版本，或者如果您的默认_charset配置选项对于给定的输入设置不正确，则强烈建议您为代码指定正确的值。本函数使用效果上，如果 string 对以下字符编码是有效的， ISO-8859-1、 ISO-8859-15、 UTF-8、 cp866、 cp1251、 cp1252、 KOI8-R 将具有相同的效果。 也就是说，在这些编码里， 受 htmlspecialchars() 影响的字符会占据相同的位置。
    double_encode 否 关闭 double_encode 时，PHP 不会转换现有的 HTML 实体， 默认是全部转换。
    encoding支持的字符编码：
    字符集 别名 描述
    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 使用的字符串。
    ''   空字符串按此顺序激活脚本编码（Zend multibyte），default_charset和当前语言环境（请参阅nl_langinfo()和setlocale()）的检测。 不建议。
    注意: 其他字符集没有认可。将会使用默认编码并抛出异常。
    注意: 本函数不会转换以上列表以外的实体。 完整转换请参见 htmlentities()。
    注意: 如果 flags 的设置模糊易混淆，将遵循以下规则：
    • 当 ENT_COMPAT、ENT_QUOTES、ENT_NOQUOTES 都没设置， 默认就是 ENT_COMPAT。
    • 如果设置不止一个 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_HTML401。
    • 如果设置不止一个 ENT_DISALLOWED、 ENT_IGNORE、 ENT_SUBSTITUTE，优先级最高的是 ENT_IGNORE， 其次是 ENT_SUBSTITUTE。

  • 返回值

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

  • 示例

    <?php
$new = htmlspecialchars("<a href='test'>Test</a>", ENT_QUOTES);
echo $new; // &lt;a href=&#039;test&#039;&gt;Test&lt;/a&gt;
?>
    尝试一下

  • 相关函数

    html_entity_decode() - 将HTML实体转换为相应的字符
    get_html_translation_table() - 返回使用 htmlspecialchars 和 htmlentities 后的转换表
    htmlspecialchars_decode() - 将特殊的 HTML 实体转换回普通字符
    strip_tags() - 从字符串中去除 HTML 和 PHP 标记
    nl2br() - 在字符串所有新行之前插入 HTML 换行标记
    htmlentities() - 将字符转换为 HTML 转义字符
返回全部字符串参考
上一节:
下一节: