From 05923f05d36ade5909d06548b76178e576bae57f Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Sat, 7 Aug 2021 13:53:58 +0000 Subject: [PATCH] Themes: Correct the documented types for theme mod values. A theme mod value can be of any type, not just a string. See #53399 git-svn-id: https://develop.svn.wordpress.org/trunk@51578 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/theme.php | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/wp-includes/theme.php b/src/wp-includes/theme.php index 7d1669caf1..384c056404 100644 --- a/src/wp-includes/theme.php +++ b/src/wp-includes/theme.php @@ -997,15 +997,15 @@ function get_theme_mods() { /** * 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. */ function get_theme_mod( $name, $default = false ) { @@ -1021,7 +1021,7 @@ function get_theme_mod( $name, $default = false ) { * * @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 ] ); } @@ -1062,8 +1062,8 @@ function set_theme_mod( $name, $value ) { * * @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 );