WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_specialchars()

wp_specialchars( string $text, string $quote_style = ENT_NOQUOTES, false|string $charset = false, false $double_encode = false ): string

In this article

Back to top

This function has been deprecated. Use esc_html() instead.

Legacy escaping for HTML blocks.

Description

See also

Parameters

$textstringrequired
Text to escape.
$quote_stylestringoptional
Unused.

Default:ENT_NOQUOTES

$charsetfalse|stringoptional
Unused.

Default:false

$double_encodefalseoptional
Whether to double encode. Unused.

Default:false

Return

string Escaped $text.

Source

function wp_specialchars( $text, $quote_style = ENT_NOQUOTES, $charset = false, $double_encode = false ) {
	_deprecated_function( __FUNCTION__, '2.8.0', 'esc_html()' );
	if ( func_num_args() > 1 ) { // Maintain back-compat for people passing additional arguments.
		return _wp_specialchars( $text, $quote_style, $charset, $double_encode );
	} else {
		return esc_html( $text );
	}
}

View all references View on Trac View on GitHub

UsesDescription
_wp_specialchars()wp-includes/formatting.php

Converts a number of special characters into their HTML entities.

esc_html()wp-includes/formatting.php

Escaping for HTML blocks.

_deprecated_function()wp-includes/functions.php

Marks a function as deprecated and inform when it has been used.

Show 1 moreShow less

Changelog

VersionDescription
2.8.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.