云策 WordPress 开发者社区

函数文档

esc_html_e()

查看官方原文 ↗
💡 云策文档标注

概述

esc_html_e() 是一个 WordPress 函数，用于显示经过翻译和 HTML 转义的文本，确保在 HTML 输出中的安全使用。如果无翻译或文本域未加载，则转义并显示原始文本。

关键要点

  • 功能：结合翻译和 HTML 转义，直接输出文本，适用于需要安全显示翻译内容的场景。
  • 参数：$text（必需，要翻译的文本）和 $domain（可选，文本域，默认为 'default'）。
  • 与相关函数的区别：esc_html__() 返回转义后的翻译文本供 PHP 使用，而 esc_html_e() 直接输出。
  • 内部实现：调用 esc_html( translate( $text, $domain ) ) 进行转义和翻译。

代码示例

function esc_html_e( $text, $domain = 'default' ) {
    echo esc_html( translate( $text, $domain ) );
}
📄 原文内容

Displays translated text that has been escaped for safe use in HTML output.

Description

If there is no translation, or the text domain isn’t loaded, the original text is escaped and displayed.

If you need the value for use in PHP, use esc_html__() .

Parameters

$textstringrequired
Text to translate.
$domainstringoptional
Text domain. Unique identifier for retrieving translated strings.
Default 'default'.

Source

function esc_html_e( $text, $domain = 'default' ) {
	echo esc_html( translate( $text, $domain ) );
}

View all references View on Trac View on GitHub

Uses Description
translate()wp-includes/l10n.php

Retrieves the translation of $text.
esc_html()wp-includes/formatting.php

Escaping for HTML blocks.
Used by Description
wp_enqueue_block_template_skip_link()wp-includes/theme-templates.php

Enqueues the skip-link script & styles.
the_block_template_skip_link()wp-includes/deprecated.php

Prints the skip-link script & styles.
WP_Privacy_Data_Removal_Requests_List_Table::column_next_steps()wp-admin/includes/class-wp-privacy-data-removal-requests-list-table.php

Outputs the Next steps column.
WP_Privacy_Data_Export_Requests_List_Table::column_next_steps()wp-admin/includes/class-wp-privacy-data-export-requests-list-table.php

Displays the next steps column.
WP_Widget_Custom_HTML::render_control_template_scripts()wp-includes/widgets/class-wp-widget-custom-html.php

Render form template scripts.
WP_Customize_Date_Time_Control::content_template()wp-includes/customize/class-wp-customize-date-time-control.php

Renders a JS template for the content of date time control.
WP_Widget_Text::render_control_template_scripts()wp-includes/widgets/class-wp-widget-text.php

Renders form template scripts.
WP_Widget_Media::render_control_template_scripts()wp-includes/widgets/class-wp-widget-media.php

Render form template scripts.
WP_Widget_Media_Image::render_control_template_scripts()wp-includes/widgets/class-wp-widget-media-image.php

Render form template scripts.
print_embed_sharing_dialog()wp-includes/embed.php

Prints the necessary markup for the embed sharing dialog.
WP_Customize_Manager::render_control_templates()wp-includes/class-wp-customize-manager.php

Renders JS templates for all registered control types.
wp_print_revision_templates()wp-admin/includes/revision.php

Print JavaScript templates required for the revisions experience.
WP_Media_List_Table::views()wp-admin/includes/class-wp-media-list-table.php

Overrides parent views to use the filter bar display.
network_step1()wp-admin/includes/network.php

Prints step 1 for Network installation process.
network_step2()wp-admin/includes/network.php

Prints step 2 for Network installation process.
wp_image_editor()wp-admin/includes/image-edit.php

Loads the WP image-editing interface.
confirm_delete_users()wp-admin/includes/ms.php
wp_print_media_templates()wp-includes/media-template.php

Prints the templates used in the media manager.

Show 13 moreShow less

Changelog

Version Description
2.8.0 Introduced.

User Contributed Notes