esc_html_x( string $text, string $context, string $domain = 'default' ): string

Translates string with gettext context, and escapes it for safe use in HTML output.

Contents

Description
Parameters
Return
Source
Related
- Uses
- Used By
Changelog
User Contributed Notes
- Feedback

Description

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

Parameters

$text string Required: Text to translate.
$context string Required: Context information for the translators.
$domain string Optional: Text domain. Unique identifier for retrieving translated strings.
Default 'default'.

Default: 'default'

Return

string Translated text.

Source

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

function esc_html_x( $text, $context, $domain = 'default' ) {
	return esc_html( translate_with_gettext_context( $text, $context, $domain ) );
}

View on Trac View on GitHub

Uses

Uses
Uses	Description
translate_with_gettext_context() wp-includes/l10n.php	Retrieves the translation of $text in the context defined in $context.
esc_html() wp-includes/formatting.php	Escaping for HTML blocks.

Used By

Used By
Used By	Description
Plugin_Installer_Skin::do_overwrite() wp-admin/includes/class-plugin-installer-skin.php	Checks if the plugin can be overwritten and outputs the HTML for overwriting a plugin on upload.
Theme_Installer_Skin::do_overwrite() wp-admin/includes/class-theme-installer-skin.php	Checks if the theme can be overwritten and outputs the HTML for overwriting a theme on upload.

Changelog

Changelog
Version	Description
2.9.0	Introduced.

User Contributed Notes

Skip to note 1 content

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

Contributed by Abdul Hadi — 3 years ago
The _x functions (like esc_html_x) are essentially the same as their _e counterparts, with an added “context” argument to explain the context a word or phrase is used in. Useful for words with multiple meanings:
```

<a href="#comment">
  <?php 
    echo esc_html_x( 
      'Comment', 
      'Verb: To leave a comment', // Here's the contextual help
      'wpdocs_my_theme' 
    ); 
  ?>
</a>

<h3>
  <?php 
    echo esc_html_x( 
      'Comment', 
      'Noun: An individual comment', // Here's the contextual help
      'wpdocs_my_theme' 
    ); 
  ?>
</h3>
```
Top ↑
Feedback
- There’s another key difference, he `_e` counterparts will output where `_x` will not. No need to echo before _e. — By admcfajn — 2 years ago
- I think it’s more accurate to say that “_x functions are essentially the same as their __ counterparts”, since _e functions include echo while _x and __ do not. — By Santiago Becerra — 2 years ago
Log in to add feedback

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