Changeset 51524

Timestamp:

08/01/2021 02:54:52 PM (23 months ago)

Author:

SergeyBiryukov

Message:

Themes: Make sure get_theme_mods() always returns an array.

This avoids a "Cannot access offset of type string on string" fatal error in set_theme_mod() on PHP 8 if the theme_mods_$theme_slug option has an incorrect value, e.g. an empty string instead of an array.

With this change, set_theme_mod() should be able to resolve the issue by saving a correct value.

Follow-up to [15736], [15739], [30672], [32629], [32632].

Props xknown.
See #51423.

Location:

trunk

Files:

• src/wp-includes/theme.php (modified) (3 diffs)
• tests/phpunit/tests/option/themeMods.php (modified) (1 diff)

trunk/src/wp-includes/theme.php

@@ -967 +967 @@
  *
  * @since 3.1.0
- *
- * @return array|void Theme modifications.
+ * @since 5.9.0 The return value is always an array.
+ *
+ * @return array Theme modifications.
  */
 function get_theme_mods() {
     $theme_slug = get_option( 'stylesheet' );
     $mods       = get_option( "theme_mods_$theme_slug" );
+
     if ( false === $mods ) {
         $theme_name = get_option( 'current_theme' );
@@ -978 +980 @@
             $theme_name = wp_get_theme()->get( 'Name' );
         }
+
         $mods = get_option( "mods_$theme_name" ); // Deprecated location.
         if ( is_admin() && false !== $mods ) {
@@ -984 +987 @@
         }
     }
+
+    if ( ! is_array( $mods ) ) {
+        $mods = array();
+    }
+
     return $mods;
 }

trunk/tests/phpunit/tests/option/themeMods.php

@@ -18 +18 @@
         set_theme_mod( 'test_name', $expected );
         $this->assertSame( $expected, get_theme_mod( 'test_name' ) );
+    }
+
+    /**
+     * @ticket 51423
+     */
+    function test_theme_mod_set_with_invalid_theme_mods_option() {
+        $theme_slug = get_option( 'stylesheet' );
+        update_option( 'theme_mods_' . $theme_slug, '' );
+        self::test_theme_mod_set();
     }