esc_html__( string $text, string $domain = 'default' )

Retrieve the translation of $text and escapes it for safe use in HTML output.

Contents

Description Description

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

Top ↑

Parameters Parameters

$text

(string) (Required) Text to translate.

$domain

(string) (Optional) Text domain. Unique identifier for retrieving translated strings.

Default value: 'default'

Top ↑

Return Return

(string) Translated text.

Top ↑

Source Source

File: wp-includes/l10n.php 

function esc_html__( $text, $domain = 'default' ) {
	return esc_html( translate( $text, $domain ) );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Uses Uses

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

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

Escaping for HTML blocks.

Top ↑

Used By Used By

Used By
Used By Description
wp-admin/includes/class-wp-comments-list-table.php: WP_Comments_List_Table::comment_status_dropdown()

Displays a comment status drop-down for filtering on the Comments list table.
wp-admin/includes/class-wp-privacy-data-removal-requests-list-table.php: WP_Privacy_Data_Removal_Requests_List_Table::column_next_steps()

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

Displays the next steps column.
wp-admin/includes/privacy-tools.php: wp_privacy_generate_personal_data_export_group_html()

Generate a single group for the personal data export report.
wp-admin/includes/privacy-tools.php: wp_privacy_generate_personal_data_export_file()

Generate the personal data export file.
wp-admin/includes/class-wp-comments-list-table.php: WP_Comments_List_Table::extra_tablenav()
Show 1 more used by Hide more used by

Top ↑

Changelog Changelog

Changelog
Version Description
2.8.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note
    Contributed by Daniel James —

    When using esc_html__, remember that it’s also possible to echo the string value out by using the related esc_html_e which does the same thing but echoes the string too.

    An example:

    <p><?php esc_html_e( 'Hello World!', 'text-domain' ); ?></p>

    You can also read more about esc_html_e too.

You must log in before being able to contribute a note or feedback.