Docs: Add missing parameter and return notations to the DocBlock for the deprecated wp_specialchars() function.

See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@36026 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-12-19 08:57:49 +00:00
parent a052a682a1
commit bb8067b666

View File

@ -2048,10 +2048,16 @@ function js_escape( $text ) {
}
/**
* Escaping for HTML blocks.
* Legacy escaping for HTML blocks.
*
* @deprecated 2.8.0 Use esc_html()
* @see esc_html()
*
* @param string $string String to escape.
* @param string $quote_style Unused.
* @param false|string $charset Unused.
* @param false $double_encode Whether to double encode. Unused.
* @return string Escaped `$string`.
*/
function wp_specialchars( $string, $quote_style = ENT_NOQUOTES, $charset = false, $double_encode = false ) {
_deprecated_function( __FUNCTION__, '2.8', 'esc_html()' );