云策 WordPress 开发者社区

函数文档

esc_attr__()

查看官方原文 ↗
💡 云策文档标注

概述

esc_attr__() 是一个 WordPress 函数，用于获取文本的翻译并转义，以便安全地用于 HTML 属性中。它结合了翻译和转义功能，确保输出在属性上下文中是安全的。

关键要点

  • 函数 esc_attr__($text, $domain = 'default') 接受两个参数：$text（必需，要翻译的文本）和 $domain（可选，文本域，默认为 'default'）。
  • 返回值为字符串：成功时返回翻译后的文本，失败时返回原始文本。
  • 内部实现基于 translate() 和 esc_attr() 函数，先翻译再转义。
  • 常用于 WordPress 核心和管理界面中，如菜单、小部件、媒体处理等场景，以确保国际化文本在属性中的安全性。

代码示例

function esc_attr__( $text, $domain = 'default' ) {
    return esc_attr( translate( $text, $domain ) );
}

注意事项

  • 如果翻译不存在或文本域未加载，函数会返回原始文本，避免中断输出。
  • 自 WordPress 2.8.0 版本引入，是处理属性中翻译文本的标准方法。
📄 原文内容

Retrieves the translation of $text and escapes it for safe use in an attribute.

Description

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

Parameters

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

Return

string Translated text on success, original text on failure.

Source

function esc_attr__( $text, $domain = 'default' ) {
	return esc_attr( translate( $text, $domain ) );
}

View all references View on Trac View on GitHub

Uses Description
translate()wp-includes/l10n.php

Retrieves the translation of $text.
esc_attr()wp-includes/formatting.php

Escaping for HTML attributes.
Used by Description
network_edit_site_nav()wp-admin/includes/ms.php

Outputs the HTML for a network’s “Edit Site” tabular interface.
WP_Customize_Nav_Menus::enqueue_scripts()wp-includes/class-wp-customize-nav-menus.php

Enqueues scripts and styles for Customizer pane.
WP_Comments_List_Table::handle_row_actions()wp-admin/includes/class-wp-comments-list-table.php

Generates and displays row actions links.
WP_Screen::render_screen_options()wp-admin/includes/class-wp-screen.php

Renders the screen options tab.
Plugin_Upgrader_Skin::after()wp-admin/includes/class-plugin-upgrader-skin.php

Performs an action following a single plugin update.
update_nag()wp-admin/includes/update.php

Returns core update notification message.
wp_dashboard_browser_nag()wp-admin/includes/dashboard.php

Displays the browser update nag.
_wp_dashboard_recent_comments_row()wp-admin/includes/dashboard.php

Outputs a row for the Recent Comments widget.
wp_media_insert_url_form()wp-admin/includes/media.php

Creates the form for external url.
edit_form_image_editor()wp-admin/includes/media.php

Displays the image and editor in the post editor
get_media_item()wp-admin/includes/media.php

Retrieves HTML form for modifying the image attachment.
WP_Media_List_Table::get_columns()wp-admin/includes/class-wp-media-list-table.php
WP_Comments_List_Table::extra_tablenav()wp-admin/includes/class-wp-comments-list-table.php
Walker_Nav_Menu_Edit::start_el()wp-admin/includes/class-walker-nav-menu-edit.php

Start the element output.
wp_nav_menu_item_post_type_meta_box()wp-admin/includes/nav-menu.php

Displays a meta box for a post type menu item.
wp_nav_menu_item_taxonomy_meta_box()wp-admin/includes/nav-menu.php

Displays a meta box for a taxonomy menu item.
WP_Posts_List_Table::get_columns()wp-admin/includes/class-wp-posts-list-table.php
_wp_menu_output()wp-admin/menu-header.php

Display menu.
wp_timezone_choice()wp-includes/functions.php

Gives a nicely-formatted list of timezone strings.
WP_Widget_RSS::widget()wp-includes/widgets/class-wp-widget-rss.php

Outputs the content for the current RSS widget instance.
WP_Customize_Widgets::enqueue_scripts()wp-includes/class-wp-customize-widgets.php

Enqueues scripts and styles for Customizer panel and export data to JavaScript.

Show 16 moreShow less

Changelog

Version Description
2.8.0 Introduced.