Changeset 57685

Timestamp:

02/21/2024 07:24:12 PM (2 months ago)

Author:

joemcgill

Message:

Themes: Use original template paths when switching blogs.

This fixes a bug introduced by [57129] and [56635] in which deprecating the previous TEMPLATEPATH and STYLESHEETPATH constants in favor of get_template_directory() and get_stylesheet_directory() functions caused the active theme template path to change when using switch_to_blog().

This introduces a new function, wp_set_template_globals(), which is called during the bootstrap process to store the template paths to new globals values $wp_template_path and $wp_stylesheet_path. This restores behavior to how things worked prior to [56635] but retains the ability for template values to be reset for better testability.

Related #18298, #60025.

Props joemcgill, flixos90, mukesh27, swissspidy, manfcarlo, metropolis_john, jeremyfelt.
Fixes #60290.

Location:

trunk

Files:

• src/wp-admin/includes/theme.php (modified) (3 diffs)
• src/wp-includes/comment-template.php (modified) (4 diffs)
• src/wp-includes/load.php (modified) (2 diffs)
• src/wp-includes/template.php (modified) (4 diffs)
• src/wp-includes/theme.php (modified) (2 diffs)
• src/wp-settings.php (modified) (1 diff)
• tests/phpunit/includes/abstract-testcase.php (modified) (1 diff)
• tests/phpunit/tests/comment/metaCache.php (modified) (1 diff)
• tests/phpunit/tests/theme.php (modified) (1 diff)

trunk/src/wp-admin/includes/theme.php

@@ -1161 +1161 @@
  * @since 5.2.0
  *
+ * @global string $wp_stylesheet_path Path to current theme's stylesheet directory.
+ * @global string $wp_template_path   Path to current theme's template directory.
+ *
  * @param string $theme    Single theme to resume.
  * @param string $redirect Optional. URL to redirect to. Default empty string.
@@ -1167 +1170 @@
  */
 function resume_theme( $theme, $redirect = '' ) {
+    global $wp_stylesheet_path, $wp_template_path;
+
     list( $extension ) = explode( '/', $theme );
 
@@ -1174 +1179 @@
      */
     if ( ! empty( $redirect ) ) {
-        $stylesheet_path = get_stylesheet_directory();
-        $template_path   = get_template_directory();
-
         $functions_path = '';
-        if ( str_contains( $stylesheet_path, $extension ) ) {
-            $functions_path = $stylesheet_path . '/functions.php';
-        } elseif ( str_contains( $template_path, $extension ) ) {
-            $functions_path = $template_path . '/functions.php';
+        if ( str_contains( $wp_stylesheet_path, $extension ) ) {
+            $functions_path = $wp_stylesheet_path . '/functions.php';
+        } elseif ( str_contains( $wp_template_path, $extension ) ) {
+            $functions_path = $wp_template_path . '/functions.php';
         }
 

trunk/src/wp-includes/comment-template.php

@@ -1391 +1391 @@
  * @since 1.5.0
  *
- * @global WP_Query   $wp_query         WordPress Query object.
- * @global WP_Post    $post             Global post object.
- * @global wpdb       $wpdb             WordPress database abstraction object.
+ * @global WP_Query   $wp_query           WordPress Query object.
+ * @global WP_Post    $post               Global post object.
+ * @global wpdb       $wpdb               WordPress database abstraction object.
  * @global int        $id
- * @global WP_Comment $comment          Global comment object.
+ * @global WP_Comment $comment            Global comment object.
  * @global string     $user_login
  * @global string     $user_identity
  * @global bool       $overridden_cpage
  * @global bool       $withcomments
+ * @global string     $wp_stylesheet_path Path to current theme's stylesheet directory.
+ * @global string     $wp_template_path   Path to current theme's template directory.
  *
  * @param string $file              Optional. The file to load. Default '/comments.php'.
@@ -1406 +1408 @@
  */
 function comments_template( $file = '/comments.php', $separate_comments = false ) {
-    global $wp_query, $withcomments, $post, $wpdb, $id, $comment, $user_login, $user_identity, $overridden_cpage;
+    global $wp_query, $withcomments, $post, $wpdb, $id, $comment, $user_login, $user_identity, $overridden_cpage, $wp_stylesheet_path, $wp_template_path;
 
     if ( ! ( is_single() || is_page() || $withcomments ) || empty( $post ) ) {
@@ -1601 +1603 @@
     }
 
-    $stylesheet_path = get_stylesheet_directory();
-    $template_path   = get_template_directory();
-
-    $theme_template = $stylesheet_path . $file;
+    $theme_template = trailingslashit( $wp_stylesheet_path ) . $file;
 
     /**
@@ -1617 +1616 @@
     if ( file_exists( $include ) ) {
         require $include;
-    } elseif ( file_exists( $template_path . $file ) ) {
-        require $template_path . $file;
+    } elseif ( file_exists( trailingslashit( $wp_template_path ) . $file ) ) {
+        require trailingslashit( $wp_template_path ) . $file;
     } else { // Backward compat code will be removed in a future release.
         require ABSPATH . WPINC . '/theme-compat/comments.php';

trunk/src/wp-includes/load.php

@@ -1047 +1047 @@
  * @access private
  *
- * @global string $pagenow The filename of the current screen.
+ * @global string $pagenow            The filename of the current screen.
+ * @global string $wp_stylesheet_path Path to current theme's stylesheet directory.
+ * @global string $wp_template_path   Path to current theme's template directory.
  *
  * @return string[] Array of absolute paths to theme directories.
  */
 function wp_get_active_and_valid_themes() {
-    global $pagenow;
+    global $pagenow, $wp_stylesheet_path, $wp_template_path;
 
     $themes = array();
@@ -1060 +1062 @@
     }
 
-    $stylesheet_path = get_stylesheet_directory();
-    $template_path   = get_template_directory();
-
-    if ( $template_path !== $stylesheet_path ) {
-        $themes[] = $stylesheet_path;
-    }
-
-    $themes[] = $template_path;
+    if ( is_child_theme() ) {
+        $themes[] = $wp_stylesheet_path;
+    }
+
+    $themes[] = $wp_template_path;
 
     /*

trunk/src/wp-includes/template.php

@@ -681 +681 @@
 
 /**
+ * Set up the globals used for template loading.
+ *
+ * @since 6.5.0
+ *
+ * @global string $wp_stylesheet_path Path to current theme's stylesheet directory.
+ * @global string $wp_template_path   Path to current theme's template directory.
+ */
+function wp_set_template_globals() {
+    global $wp_stylesheet_path, $wp_template_path;
+
+    $wp_stylesheet_path = get_stylesheet_directory();
+    $wp_template_path   = get_template_directory();
+}
+
+/**
  * Retrieves the name of the highest priority template file that exists.
  *
@@ -689 +704 @@
  * @since 2.7.0
  * @since 5.5.0 The `$args` parameter was added.
+ *
+ * @global string $wp_stylesheet_path Path to current theme's stylesheet directory.
+ * @global string $wp_template_path   Path to current theme's template directory.
  *
  * @param string|array $template_names Template file(s) to search for, in order.
@@ -699 +717 @@
  */
 function locate_template( $template_names, $load = false, $load_once = true, $args = array() ) {
-    $stylesheet_path = get_stylesheet_directory();
-    $template_path   = get_template_directory();
-    $is_child_theme  = $stylesheet_path !== $template_path;
+    global $wp_stylesheet_path, $wp_template_path;
+
+    if ( ! isset( $wp_stylesheet_path ) || ! isset( $wp_template_path ) ) {
+        wp_set_template_globals();
+    }
+
+    $is_child_theme = is_child_theme();
 
     $located = '';
@@ -708 +730 @@
             continue;
         }
-        if ( file_exists( $stylesheet_path . '/' . $template_name ) ) {
-            $located = $stylesheet_path . '/' . $template_name;
+        if ( file_exists( $wp_stylesheet_path . '/' . $template_name ) ) {
+            $located = $wp_stylesheet_path . '/' . $template_name;
             break;
-        } elseif ( $is_child_theme && file_exists( $template_path . '/' . $template_name ) ) {
-            $located = $template_path . '/' . $template_name;
+        } elseif ( $is_child_theme && file_exists( $wp_template_path . '/' . $template_name ) ) {
+            $located = $wp_template_path . '/' . $template_name;
             break;
         } elseif ( file_exists( ABSPATH . WPINC . '/theme-compat/' . $template_name ) ) {

trunk/src/wp-includes/theme.php

@@ -154 +154 @@
  *
  * @since 3.0.0
+ * @since 6.5.0 Makes use of global template variables.
+ *
+ * @global string $wp_stylesheet_path Path to current theme's stylesheet directory.
+ * @global string $wp_template_path   Path to current theme's template directory.
  *
  * @return bool True if a child theme is in use, false otherwise.
  */
 function is_child_theme() {
-    return get_template_directory() !== get_stylesheet_directory();
+    global $wp_stylesheet_path, $wp_template_path;
+
+    return $wp_stylesheet_path !== $wp_template_path;
 }
 
@@ -836 +842 @@
 
     update_option( 'theme_switched', $old_theme->get_stylesheet() );
+
+    /*
+     * Reset template globals when switching themes outside of a switched blog
+     * context to ensure templates will be loaded from the new theme.
+     */
+    if ( ! is_multisite() || ! ms_is_switched() ) {
+        wp_set_template_globals();
+    }
 
     // Clear pattern caches.

trunk/src/wp-settings.php

@@ -609 +609 @@
 do_action( 'setup_theme' );
 
-// Define the template related constants.
+// Define the template related constants and globals.
 wp_templating_constants();
+wp_set_template_globals();
 
 // Load the default text localization domain.

trunk/tests/phpunit/includes/abstract-testcase.php

@@ -190 +190 @@
          */
         $GLOBALS['wp_sitemaps'] = null;
+
+        // Reset template globals.
+        $GLOBALS['wp_stylesheet_path'] = null;
+        $GLOBALS['wp_template_path']   = null;
 
         $this->unregister_all_meta_keys();

trunk/tests/phpunit/tests/comment/metaCache.php

@@ -6 +6 @@
     protected $i       = 0;
     protected $queries = 0;
+
+    /**
+     * Performs setup tasks for every test.
+     */
+    public function set_up() {
+        parent::set_up();
+        switch_theme( 'default' );
+    }
 
     /**

trunk/tests/phpunit/tests/theme.php

@@ -1306 +1306 @@
         $this->assertSame( $new_root . '/test-parent', $path2, 'The new template path is not correct' );
     }
+
+    /**
+     * Tests that switch_to_blog() uses the original template path.
+     *
+     * @ticket 60290
+     *
+     * @group ms-required
+     *
+     * @covers ::locate_template
+     */
+    public function test_switch_to_blog_uses_original_template_path() {
+        $old_theme     = wp_get_theme();
+        $template_path = locate_template( 'index.php' );
+
+        $blog_id = self::factory()->blog->create();
+        switch_to_blog( $blog_id );
+
+        switch_theme( 'block-theme' );
+        $new_template_path = locate_template( 'index.php' );
+
+        // Cleanup.
+        restore_current_blog();
+        switch_theme( $old_theme->get_stylesheet() );
+
+        $this->assertSame( $template_path, $new_template_path, 'Switching blogs switches the template path' );
+    }
 }