From bb8067b666a885bf3cb5168f075f91bc9fa08b1b Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sat, 19 Dec 2015 08:57:49 +0000 Subject: [PATCH] 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 --- src/wp-includes/deprecated.php | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/wp-includes/deprecated.php b/src/wp-includes/deprecated.php index e95c7873e5..39f3e43802 100644 --- a/src/wp-includes/deprecated.php +++ b/src/wp-includes/deprecated.php @@ -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()' );