Changeset 57685 for trunk/src/wp-includes/template.php

Timestamp:

02/21/2024 07:24:12 PM (10 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.

File:

• trunk/src/wp-includes/template.php (modified) (4 diffs)

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 ) ) {