WordPress Developer Resources

esc_html__( string $text, string $domain = ‘default’ ): string

Retrieves 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.

Parameters

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

Return

string Translated text.

Source

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

View all references View on Trac View on GitHub

Changelog

Version	Description
2.8.0	Introduced.

User Contributed Notes

Skip to note 3 content

izem 8 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 5You must log in to vote on the helpfulness of this note
Use to embed translations inside HTML. This way you ensure that third party translation are sanitized and will not break the code (proper security to keep the users safe).
```
<h1><?php echo esc_html__( 'Title', 'text-domain' ) ?></h3>
```
Log in to add feedback
Skip to note 4 content

danieltj 7 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 5You must log in to vote on the helpfulness of this note
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.
Log in to add feedback

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