Changeset 51578

Timestamp:

08/07/2021 01:53:58 PM (3 years ago)

Author:

johnbillion

Message:

Themes: Correct the documented types for theme mod values.

A theme mod value can be of any type, not just a string.

See #53399

File:

• trunk/src/wp-includes/theme.php (modified) (3 diffs)

trunk/src/wp-includes/theme.php

@@ -998 +998 @@
  * Retrieves theme modification value for the current theme.
  *
- * If the modification name does not exist, then the $default will be passed
- * through {@link https://www.php.net/sprintf sprintf()} PHP function with
- * the template directory URI as the first string and the stylesheet directory URI
- * as the second string.
+ * If the modification name does not exist and `$default` is a string, then the
+ * default will be passed through the {@link https://www.php.net/sprintf sprintf()}
+ * PHP function with the template directory URI as the first value and the
+ * stylesheet directory URI as the second value.
  *
  * @since 2.1.0
  *
- * @param string       $name    Theme modification name.
- * @param string|false $default Optional. Theme modification default value. Default false.
+ * @param string $name    Theme modification name.
+ * @param mixed  $default Optional. Theme modification default value. Default false.
  * @return mixed Theme modification value.
  */
@@ -1022 +1022 @@
          * @since 2.2.0
          *
-         * @param string $current_mod The value of the current theme modification.
+         * @param mixed $current_mod The value of the current theme modification.
          */
         return apply_filters( "theme_mod_{$name}", $mods[ $name ] );
@@ -1063 +1063 @@
      * @since 3.9.0
      *
-     * @param string $value     The new value of the theme modification.
-     * @param string $old_value The current value of the theme modification.
+     * @param mixed $value     The new value of the theme modification.
+     * @param mixed $old_value The current value of the theme modification.
      */
     $mods[ $name ] = apply_filters( "pre_set_theme_mod_{$name}", $value, $old_value );