esc_attr_x() WordPress Function

The esc_attr_x() function is used to escape HTML attributes in WordPress. It is similar to the esc_attr() function, but with the addition of the xsl:escape-markup option. This function is used when outputting data that might be used in an HTML attribute, such as a title or alt attribute.

esc_attr_x( string $text, string $context, string $domain = 'default' ) #

Translate string with gettext context, 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 escaped and returned.


Top ↑

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 value: 'default'


Top ↑

Return

(string) Translated text.


Top ↑

Source

File: wp-includes/l10n.php

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


Top ↑

Changelog

Changelog
VersionDescription
2.8.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.