Changeset 56986 for branches/6.4

Timestamp:

10/23/2023 04:02:02 PM (12 months ago)

Author:

flixos90

Message:

Multisite: Ensure that switching sites resets the current theme directory globals.

The globals introduced in [56635] to cache the current theme directories in memory were not considering switching sites in a multisite network. This changeset addresses the bug including test coverage.

Props codex-m, jeremyfelt, costdev, joemcgill.
Merges [56974] to the 6.4 branch.
Fixes #59677.
See #18298.

Location:

branches/6.4

Files:

• . (modified) (1 prop)
• src/wp-includes/ms-blogs.php (modified) (4 diffs)
• tests/phpunit/tests/theme.php (modified) (1 diff)

branches/6.4/src/wp-includes/ms-blogs.php

@@ -492 +492 @@
  * @global bool            $switched
  * @global string          $table_prefix
+ * @global string          $wp_template_path
+ * @global string          $wp_stylesheet_path
  * @global WP_Object_Cache $wp_object_cache
  *
@@ -533 +535 @@
 
     $wpdb->set_blog_id( $new_blog_id );
-    $GLOBALS['table_prefix'] = $wpdb->get_blog_prefix();
-    $GLOBALS['blog_id']      = $new_blog_id;
+    $GLOBALS['table_prefix']       = $wpdb->get_blog_prefix();
+    $GLOBALS['blog_id']            = $new_blog_id;
+    $GLOBALS['wp_template_path']   = null;
+    $GLOBALS['wp_stylesheet_path'] = null;
 
     if ( function_exists( 'wp_cache_switch_to_blog' ) ) {
@@ -601 +605 @@
  * @global bool            $switched
  * @global string          $table_prefix
+ * @global string          $wp_template_path
+ * @global string          $wp_stylesheet_path
  * @global WP_Object_Cache $wp_object_cache
  *
@@ -626 +632 @@
 
     $wpdb->set_blog_id( $new_blog_id );
-    $GLOBALS['blog_id']      = $new_blog_id;
-    $GLOBALS['table_prefix'] = $wpdb->get_blog_prefix();
+    $GLOBALS['blog_id']            = $new_blog_id;
+    $GLOBALS['table_prefix']       = $wpdb->get_blog_prefix();
+    $GLOBALS['wp_template_path']   = null;
+    $GLOBALS['wp_stylesheet_path'] = null;
 
     if ( function_exists( 'wp_cache_switch_to_blog' ) ) {

branches/6.4/tests/phpunit/tests/theme.php

@@ -1060 +1060 @@
 
     /**
+     * Tests whether a switched site retrieves the correct stylesheet directory.
+     *
+     * @ticket 59677
+     * @group ms-required
+     *
+     * @covers ::get_stylesheet_directory
+     */
+    public function test_get_stylesheet_directory_with_switched_site() {
+        $blog_id = self::factory()->blog->create();
+
+        update_blog_option( $blog_id, 'stylesheet', 'switched_stylesheet' );
+
+        // Prime global storage with the current site's data.
+        get_stylesheet_directory();
+
+        switch_to_blog( $blog_id );
+        $switched_stylesheet = get_stylesheet_directory();
+        restore_current_blog();
+
+        $this->assertSame( WP_CONTENT_DIR . '/themes/switched_stylesheet', $switched_stylesheet );
+    }
+
+    /**
+     * Tests whether a switched site retrieves the correct template directory.
+     *
+     * @ticket 59677
+     * @group ms-required
+     *
+     * @covers ::get_template_directory
+     */
+    public function test_get_template_directory_with_switched_site() {
+        $blog_id = self::factory()->blog->create();
+
+        update_blog_option( $blog_id, 'template', 'switched_template' );
+
+        // Prime global storage with the current site's data.
+        get_template_directory();
+
+        switch_to_blog( $blog_id );
+        $switched_template = get_template_directory();
+        restore_current_blog();
+
+        $this->assertSame( WP_CONTENT_DIR . '/themes/switched_template', $switched_template );
+    }
+
+    /**
+     * Tests whether a restored site retrieves the correct stylesheet directory.
+     *
+     * @ticket 59677
+     * @group ms-required
+     *
+     * @covers ::get_stylesheet_directory
+     */
+    public function test_get_stylesheet_directory_with_restored_site() {
+        $blog_id = self::factory()->blog->create();
+
+        update_option( 'stylesheet', 'original_stylesheet' );
+        update_blog_option( $blog_id, 'stylesheet', 'switched_stylesheet' );
+
+        $stylesheet = get_stylesheet_directory();
+
+        switch_to_blog( $blog_id );
+
+        // Prime global storage with the restored site's data.
+        get_stylesheet_directory();
+        restore_current_blog();
+
+        $this->assertSame( WP_CONTENT_DIR . '/themes/original_stylesheet', $stylesheet );
+    }
+
+    /**
+     * Tests whether a restored site retrieves the correct template directory.
+     *
+     * @ticket 59677
+     * @group ms-required
+     *
+     * @covers ::get_template_directory
+     */
+    public function test_get_template_directory_with_restored_site() {
+        $blog_id = self::factory()->blog->create();
+
+        update_option( 'template', 'original_template' );
+        update_blog_option( $blog_id, 'template', 'switched_template' );
+
+        $template = get_template_directory();
+
+        switch_to_blog( $blog_id );
+
+        // Prime global storage with the switched site's data.
+        get_template_directory();
+        restore_current_blog();
+
+        $this->assertSame( WP_CONTENT_DIR . '/themes/original_template', $template );
+    }
+
+    /**
      * Helper function to ensure that a block theme is available and active.
      */