Changeset 57302

Timestamp:

01/17/2024 09:07:15 AM (7 months ago)

Author:

audrasjb

Message:

Docs: Fix var types of parameters in sanitize_option() and sanitize_option_{$option}.

The related docblocks were previously defining $value and $original_value as if they were of type string, but they can also be of other types, like array.

Props gerardreches, crstauf, mukesh27.
Fixes #60214.
See #59651.

File:

• trunk/src/wp-includes/formatting.php (modified) (2 diffs)

trunk/src/wp-includes/formatting.php

@@ -4847 +4847 @@
  *
  * @param string $option The name of the option.
- * @param string $value  The unsanitized value.
- * @return string Sanitized value.
+ * @param  $value  The unsanitized value.
+ * @return  Sanitized value.
  */
 function sanitize_option( $option, $value ) {
@@ -5120 +5120 @@
      * @since 4.3.0 Added the `$original_value` parameter.
      *
-     * @param string $value          The sanitized option value.
+     * @param  $value          The sanitized option value.
      * @param string $option         The option name.
-     * @param string $original_value The original value passed to the function.
+     * @param  $original_value The original value passed to the function.
      */
     return apply_filters( "sanitize_option_{$option}", $value, $option, $original_value );