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

Retrieve the translation of $text and escapes it 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 returned.


Top ↑

Parameters

$text string Required
Text to translate.
$domain string Optional
Text domain. Unique identifier for retrieving translated strings.
Default 'default'.

Default: 'default'


Top ↑

Return

string Translated text.


Top ↑

Source

File: wp-includes/l10n.php. View all references

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


Top ↑

Changelog

Changelog
Version Description
2.8.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 2 content
    Contributed by danieltj

    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.