mirror of
https://github.com/php/doc-zh.git
synced 2026-03-24 15:12:20 +01:00
264 lines
7.9 KiB
XML
264 lines
7.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<!-- $Revision$ -->
|
||
<!-- EN-Revision: 06394ea77c2f8972e3884c00bede861ef5eb04da Maintainer: daijie Status: ready -->
|
||
<!-- CREDITS: mowangjuanzi -->
|
||
<refentry xml:id="function.htmlentities" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||
<refnamediv>
|
||
<refname>htmlentities</refname>
|
||
<refpurpose>将字符转换为 HTML 转义字符</refpurpose>
|
||
</refnamediv>
|
||
|
||
<refsect1 role="description">
|
||
&reftitle.description;
|
||
<methodsynopsis>
|
||
<type>string</type><methodname>htmlentities</methodname>
|
||
<methodparam><type>string</type><parameter>string</parameter></methodparam>
|
||
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401</initializer></methodparam>
|
||
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
|
||
<methodparam choice="opt"><type>bool</type><parameter>double_encode</parameter><initializer>&true;</initializer></methodparam>
|
||
</methodsynopsis>
|
||
<para>
|
||
本函数各方面都和 <function>htmlspecialchars</function> 一样，除了 <function>htmlentities</function> 会转换所有具有 HTML
|
||
实体的字符。<function>get_html_translation_table</function> 可根据提供的 <parameter>flags</parameter> 常量返回使用的翻译表。
|
||
</para>
|
||
<para>
|
||
如果要解码（反向操作），可以使用 <function>html_entity_decode</function>。
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="parameters">
|
||
&reftitle.parameters;
|
||
<para>
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term><parameter>string</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
输入字符。
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>flags</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
以下一组位掩码标记，用于设置如何处理引号、无效代码序列、使用文档的类型。默认是
|
||
<literal>ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401</literal>。
|
||
<table>
|
||
<title>有效 <parameter>flags</parameter> 标记常量</title>
|
||
<tgroup cols="2">
|
||
<thead>
|
||
<row>
|
||
<entry>常量名</entry>
|
||
<entry>描述</entry>
|
||
</row>
|
||
</thead>
|
||
<tbody>
|
||
<row>
|
||
<entry><constant>ENT_COMPAT</constant></entry>
|
||
<entry>会转换双引号，不转换单引号。</entry>
|
||
</row>
|
||
<row>
|
||
<entry><constant>ENT_QUOTES</constant></entry>
|
||
<entry>既转换双引号也转换单引号。</entry>
|
||
</row>
|
||
<row>
|
||
<entry><constant>ENT_NOQUOTES</constant></entry>
|
||
<entry>单/双引号都不转换</entry>
|
||
</row>
|
||
<row>
|
||
<entry><constant>ENT_IGNORE</constant></entry>
|
||
<entry>
|
||
静默丢弃无效的代码单元序列，而不是返回空字符串。
|
||
不建议使用此标记，
|
||
因为它<link xlink:href="&url.delete.nonchars;">可能有安全影响</link>。
|
||
</entry>
|
||
</row>
|
||
<row>
|
||
<entry><constant>ENT_SUBSTITUTE</constant></entry>
|
||
<entry>
|
||
替换无效的代码单元序列为 Unicode 代替符（Replacement Character），
|
||
U+FFFD (UTF-8) 或者 &#xFFFD; (其他)，而不是返回空字符串。
|
||
</entry>
|
||
</row>
|
||
<row>
|
||
<entry><constant>ENT_DISALLOWED</constant></entry>
|
||
<entry>
|
||
为文档的无效代码点替换为 Unicode 代替符（Replacement Character）：
|
||
U+FFFD (UTF-8)，或 &#xFFFD;（其他），而不是把它们留在原处。
|
||
比如以下情况下就很有用：要保证 XML 文档嵌入额外内容时格式合法。
|
||
</entry>
|
||
</row>
|
||
<row>
|
||
<entry><constant>ENT_HTML401</constant></entry>
|
||
<entry>
|
||
以 HTML 4.01 处理代码。
|
||
</entry>
|
||
</row>
|
||
<row>
|
||
<entry><constant>ENT_XML1</constant></entry>
|
||
<entry>
|
||
以 XML 1 处理代码。
|
||
</entry>
|
||
</row>
|
||
<row>
|
||
<entry><constant>ENT_XHTML</constant></entry>
|
||
<entry>
|
||
以 XHTML 处理代码。
|
||
</entry>
|
||
</row>
|
||
<row>
|
||
<entry><constant>ENT_HTML5</constant></entry>
|
||
<entry>
|
||
以 HTML 5 处理代码。
|
||
</entry>
|
||
</row>
|
||
</tbody>
|
||
</tgroup>
|
||
</table>
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>encoding</parameter></term>
|
||
<listitem>
|
||
&strings.parameter.encoding;
|
||
&reference.strings.charsets;
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>double_encode</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
关闭 <parameter>double_encode</parameter> 时，PHP 不会转换现有的 HTML 实体，
|
||
默认是全部转换。
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="returnvalues">
|
||
&reftitle.returnvalues;
|
||
<para>
|
||
返回编码后的字符。
|
||
</para>
|
||
<para>
|
||
如果指定的编码 <parameter>encoding</parameter> 里，
|
||
<parameter>string</parameter> 包含了无效的代码单元序列，
|
||
没有设置 <constant>ENT_IGNORE</constant> 或者
|
||
<constant>ENT_SUBSTITUTE</constant> 标记的情况下，会返回空字符串。
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="changelog">
|
||
&reftitle.changelog;
|
||
<informaltable>
|
||
<tgroup cols="2">
|
||
<thead>
|
||
<row>
|
||
<entry>&Version;</entry>
|
||
<entry>&Description;</entry>
|
||
</row>
|
||
</thead>
|
||
<tbody>
|
||
<row>
|
||
<entry>8.1.0</entry>
|
||
<entry>
|
||
<parameter>flags</parameter> 从 <constant>ENT_COMPAT</constant> 变更为 <constant>ENT_QUOTES</constant> | <constant>ENT_SUBSTITUTE</constant> | <constant>ENT_HTML401</constant>。
|
||
</entry>
|
||
</row>
|
||
<row>
|
||
<entry>8.0.0</entry>
|
||
<entry>
|
||
<parameter>encoding</parameter> 现在可以为 null。
|
||
</entry>
|
||
</row>
|
||
</tbody>
|
||
</tgroup>
|
||
</informaltable>
|
||
</refsect1>
|
||
|
||
<refsect1 role="examples">
|
||
&reftitle.examples;
|
||
<para>
|
||
<example>
|
||
<title><function>htmlentities</function> 示例</title>
|
||
<programlisting role="php">
|
||
<![CDATA[
|
||
<?php
|
||
$str = "A 'quote' is <b>bold</b>";
|
||
|
||
echo htmlentities($str);
|
||
echo "\n\n";
|
||
echo htmlentities($str, ENT_COMPAT);
|
||
?>
|
||
]]>
|
||
</programlisting>
|
||
&example.outputs;
|
||
<screen>
|
||
<![CDATA[
|
||
A 'quote' is <b>bold</b>
|
||
|
||
A 'quote' is <b>bold</b>
|
||
]]>
|
||
</screen>
|
||
</example>
|
||
</para>
|
||
|
||
<para>
|
||
<example>
|
||
<title><constant>ENT_IGNORE</constant> 用法示例</title>
|
||
<programlisting role="php">
|
||
<![CDATA[
|
||
<?php
|
||
$str = "\x8F!!!";
|
||
|
||
// 输出空 string
|
||
echo htmlentities($str, ENT_QUOTES, "UTF-8");
|
||
|
||
// 输出 "!!!"
|
||
echo htmlentities($str, ENT_QUOTES | ENT_IGNORE, "UTF-8");
|
||
?>
|
||
]]>
|
||
</programlisting>
|
||
</example>
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="seealso">
|
||
&reftitle.seealso;
|
||
<para>
|
||
<simplelist>
|
||
<member><function>html_entity_decode</function></member>
|
||
<member><function>get_html_translation_table</function></member>
|
||
<member><function>htmlspecialchars</function></member>
|
||
<member><function>nl2br</function></member>
|
||
<member><function>urlencode</function></member>
|
||
</simplelist>
|
||
</para>
|
||
</refsect1>
|
||
|
||
</refentry>
|
||
<!-- Keep this comment at the end of the file
|
||
Local variables:
|
||
mode: sgml
|
||
sgml-omittag:t
|
||
sgml-shorttag:t
|
||
sgml-minimize-attributes:nil
|
||
sgml-always-quote-attributes:t
|
||
sgml-indent-step:1
|
||
sgml-indent-data:t
|
||
indent-tabs-mode:nil
|
||
sgml-parent-document:nil
|
||
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
||
sgml-exposed-tags:nil
|
||
sgml-local-catalogs:nil
|
||
sgml-local-ecat-files:nil
|
||
End:
|
||
vim600: syn=xml fen fdm=syntax fdl=2 si
|
||
vim: et tw=78 syn=sgml
|
||
vi: ts=1 sw=1
|
||
-->
|