Changeset 57685 for trunk/src/wp-includes/comment-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/comment-template.php (modified) (4 diffs)

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';