[PHPStan]: typehint esc_* functions

Author: justlevine

src/wp-includes/formatting.php

@@ -938,6 +938,8 @@ function seems_utf8( $str ) {
  * @param false|string $charset       Optional. The character encoding of the string. Default false.
  * @param bool         $double_encode Optional. Whether to encode existing HTML entities. Default false.
  * @return string The encoded text with HTML entities.
+ *
+ * @phpstan-param scalar $text
  */
 function _wp_specialchars( $text, $quote_style = ENT_NOQUOTES, $charset = false, $double_encode = false ) {
 	$text = (string) $text;
@@ -1008,6 +1010,8 @@ function _wp_specialchars( $text, $quote_style = ENT_NOQUOTES, $charset = false,
  *                                double if set to 'double' or both if otherwise set.
  *                                Default is ENT_NOQUOTES.
  * @return string The decoded text without HTML entities.
+ *
+ * @phpstan-param scalar $text
  */
 function wp_specialchars_decode( $text, $quote_style = ENT_NOQUOTES ) {
 	$text = (string) $text;
@@ -1091,6 +1095,8 @@ function wp_specialchars_decode( $text, $quote_style = ENT_NOQUOTES ) {
  * @param string $text   The text which is to be checked.
  * @param bool   $strip  Optional. Whether to attempt to strip out invalid UTF8. Default false.
  * @return string The checked text.
+ *
+ * @phpstan-param scalar $text
  */
 function wp_check_invalid_utf8( $text, $strip = false ) {
 	$text = (string) $text;
@@ -4656,6 +4662,8 @@ function htmlentities2( $text ) {
  *
  * @param string $text The text to be escaped.
  * @return string Escaped text.
+ *
+ * @phpstan-param scalar $text
  */
 function esc_js( $text ) {
 	$safe_text = wp_check_invalid_utf8( $text );
@@ -4684,6 +4692,8 @@ function esc_js( $text ) {
  *
  * @param string $text
  * @return string
+ *
+ * @phpstan-param scalar $text
  */
 function esc_html( $text ) {
 	$safe_text = wp_check_invalid_utf8( $text );
@@ -4707,8 +4717,10 @@ function esc_html( $text ) {
  *
  * @since 2.8.0
  *
- * @param string $text
+ * @param string $text . Non-string values will be cast to string.
  * @return string
+ *
+ * @phpstan-param scalar $text
  */
 function esc_attr( $text ) {
 	$safe_text = wp_check_invalid_utf8( $text );
@@ -4723,6 +4735,8 @@ function esc_attr( $text ) {
 	 *
 	 * @param string $safe_text The text after it has been escaped.
 	 * @param string $text      The text prior to being escaped.
+	 *
+	 * @phpstan-param scalar $text
 	 */
 	return apply_filters( 'attribute_escape', $safe_text, $text );
 }
@@ -4755,6 +4769,8 @@ function esc_textarea( $text ) {
  *
  * @param string $text Text to escape.
  * @return string Escaped text.
+ *
+ * @phpstan-param scalar $text
  */
 function esc_xml( $text ) {
 	$safe_text = wp_check_invalid_utf8( $text );