esc_attr() WordPress Function

The esc_attr() function is used to escape HTML attributes in WordPress. It is similar to the WordPress_esc_html() function, but with a few notable differences. The most notable difference is that the esc_attr() function also escapes quotes, which the WordPress_esc_html() function does not. This function is typically used when outputting data that may be used in an HTML attribute, such as when using the get_the_title() function.

esc_attr( string $text ) #

Escaping for HTML attributes.


Parameters

$text

(string)(Required)


Top ↑

Return

(string)


Top ↑

More Information

Encodes the <, >, &, ” and ‘ (less than, greater than, ampersand, double quote and single quote) characters. Will never double encode entities.

Always use when escaping HTML attributes (especially form values) such as alt, value, title, etc. To escape the value of a translation use esc_attr__() instead; to escape, translate and echo, use esc_attr_e().


Top ↑

Source

File: wp-includes/formatting.php

function esc_attr( $text ) {
	$safe_text = wp_check_invalid_utf8( $text );
	$safe_text = _wp_specialchars( $safe_text, ENT_QUOTES );
	/**
	 * Filters a string cleaned and escaped for output in an HTML attribute.
	 *
	 * Text passed to esc_attr() is stripped of invalid or special characters
	 * before output.
	 *
	 * @since 2.0.6
	 *
	 * @param string $safe_text The text after it has been escaped.
	 * @param string $text      The text prior to being escaped.
	 */
	return apply_filters( 'attribute_escape', $safe_text, $text );
}


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.

Show More