esc_html_e( string $text, string $domain = 'default' )
- Since
- 2.8.0
- Source
wp-includes/l10n.php:388
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
$textstring- Text to translate.
$domainstringoptional- Text domain. Unique identifier for retrieving translated strings.
Default 'default'.Default:'default'
Performance profile
How much work a call to esc_html_e() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 11
- Plugin surface
- None
- Called by
- 19
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.4. The body compiles to 11.
Nothing here hands control to plugin code.
19 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()one call below esc_html_e()
Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost esc_html_e() can have, taken from its control-flow graph on PHP 8.4.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 11 | translate(), esc_html() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3 and 8.4: 11 instructions, 11 executed per call, 0 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 2
- esc_html()Escaping for HTML blocks.
- translate()Retrieves the translation of $text.
Used by · 19
- Twenty_Twenty_One_Customize_Notice_Control::render_content()Renders the control content.
- WP_Customize_Date_Time_Control::content_template()Renders a JS template for the content of date time control.
- WP_Customize_Manager::render_control_templates()Renders JS templates for all registered control types.
- WP_Media_List_Table::views()Overrides parent views to use the filter bar display.
- WP_Privacy_Data_Export_Requests_List_Table::column_next_steps()Displays the next steps column.
- WP_Privacy_Data_Removal_Requests_List_Table::column_next_steps()Outputs the Next steps column.
- WP_Widget_Custom_HTML::render_control_template_scripts()Render form template scripts.
- WP_Widget_Media::render_control_template_scripts()Render form template scripts.
- WP_Widget_Media_Image::render_control_template_scripts()Render form template scripts.
- WP_Widget_Text::render_control_template_scripts()Renders form template scripts.
- confirm_delete_users()
- edit_form_image_editor()Displays the image and editor in the post editor
Show all 19
- network_step1()Prints step 1 for Network installation process.
- network_step2()Prints step 2 for Network installation process.
- print_embed_sharing_dialog()Prints the necessary markup for the embed sharing dialog.
- the_block_template_skip_link()Prints the skip-link script & styles.
- wp_image_editor()Loads the WP image-editing interface.
- wp_print_media_templates()Prints the templates used in the media manager.
- wp_print_revision_templates()Print JavaScript templates required for the revisions experience.
Source code
function esc_html_e( $text, $domain = 'default' ) { echo esc_html( translate( $text, $domain ) );}Changelog
Introduced in 2.8.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/l10n.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.