esc_attr__( string $text, string $domain = 'default' ): string
- Since
- 2.8.0
- Source
wp-includes/l10n.php:322
Description
If there is no translation, or the text domain isn't loaded, the original text is returned.
Compatibility
- WordPress
- since 2.8.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$textstring- Text to translate.
$domainstringoptional- Text domain. Unique identifier for retrieving translated strings.
Default 'default'.Default:'default'
Return value
string- Translated text on success, original text on failure.
Performance profile
How much work a call to esc_attr__() 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
- 10
- Plugin surface
- None
- Called by
- 25
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.5. The body compiles to 10.
Nothing here hands control to plugin code.
25 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_attr__()
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_attr__() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 10 | translate(), esc_attr() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 10 instructions, 10 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_attr()Escaping for HTML attributes.
- translate()Retrieves the translation of $text.
Used by · 25
- Plugin_Upgrader_Skin::after()Performs an action following a single plugin update.
- WP_Comments_List_Table::extra_tablenav()
- WP_Comments_List_Table::handle_row_actions()Generates and displays row actions links.
- WP_Customize_Nav_Menus::enqueue_scripts()Enqueues scripts and styles for Customizer pane.
- WP_Customize_Widgets::enqueue_scripts()Enqueues scripts and styles for Customizer panel and export data to JavaScript.
- WP_Media_List_Table::get_columns()
- WP_Posts_List_Table::get_columns()
- WP_Screen::render_screen_options()Renders the screen options tab.
- WP_Widget_RSS::widget()Outputs the content for the current RSS widget instance.
- Walker_Nav_Menu_Edit::start_el()Start the element output.
- _wp_dashboard_recent_comments_row()Outputs a row for the Recent Comments widget.
- _wp_menu_output()Display menu.
Show all 25
- block_core_image_print_lightbox_overlay()
- edit_form_image_editor()Displays the image and editor in the post editor
- get_media_item()Retrieves HTML form for modifying the image attachment.
- network_edit_site_nav()Outputs the HTML for a network's "Edit Site" tabular interface.
- twenty_twenty_one_get_starter_content()Returns the array of starter content for the theme.
- twenty_twenty_one_register_block_pattern()Registers Block Pattern.
- twentynineteen_add_ellipses_to_nav()Adds an extra menu to our nav for our priority+ navigation to use.
- update_nag()Returns core update notification message.
- wp_dashboard_browser_nag()Displays the browser update nag.
- wp_media_insert_url_form()Creates the form for external url.
- wp_nav_menu_item_post_type_meta_box()Displays a meta box for a post type menu item.
- wp_nav_menu_item_taxonomy_meta_box()Displays a meta box for a taxonomy menu item.
- wp_timezone_choice()Gives a nicely-formatted list of timezone strings.
Source code
function esc_attr__( $text, $domain = 'default' ) { return esc_attr( 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 6.9.7 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.