esc_html()将 < > & \" \'(小于号,大于号,&,双引号,单引号)编码,转成HTML 实体

目录

描述

将 < > & " '(小 号,大于号,&,双引  引号)编码,转成HTML 实体,已经是实体的并不转换。

功能和 esc_attr() 类似。

esc_html() 描述

用法

<?php esc_html$text ?>

esc_html() 用法

参数

$text

(string) (必填) 将编码成实体的文本。

默认值: None

esc_html() 参数

返回值

HTML (string

 经编码成 HTML 实体的文本。

esc_html() 返回值

示例

/* ----------------------------------
 * wordpress之魂 © http://wphun.com
 * ---------------------------------- */

$html = esc_html( '<a href="http://www.example.com/">A link</a>' );

$html now contains this:

/* ----------------------------------
 * wordpress之魂 © http://wphun.com
 * ---------------------------------- */

&lt;a href=&quot;http://www.example.com/&quot;&gt;A link&lt;/a&gt;

Which would be displayed in an HTML document as:

/* ----------------------------------
 * wordpress之魂 © http://wphun.com
 * ---------------------------------- */

<a href="http://www.example.com/">A link</a>

Instead of this:

A link

esc_html() 示例

注意

  • 使用到 the 'esc_html' 过滤器.

esc_html() 注意

历史

  • 添加于 版本: 2.8.0

esc_html() 历史

源文件

esc_html() 函数的代码位于 wp-includes/formatting.php.

/* ----------------------------------
 * wordpress之魂 © http://wphun.com
 * ---------------------------------- */
/**
 * Escaping for HTML blocks.
 *
 * @since 2.8.0
 *
 * @param string $text
 * @return string
 */
function esc_html( $text ) {
	$safe_text = wp_check_invalid_utf8( $text );
	$safe_text = _wp_specialchars( $safe_text, ENT_QUOTES );
	/**
	 * Filter a string cleaned and escaped for output in HTML.
	 *
	 * Text passed to esc_html() is stripped of invalid or special characters
	 * before output.
	 *
	 * @since 2.8.0
	 *
	 * @param string $safe_text The text after it has been escaped.
 	 * @param string $text      The text prior to being escaped.
	 */
	return apply_filters( 'esc_html', $safe_text, $text );
}

esc_html() 源文件

相关