Changeset 57156

Timestamp:

12/04/2023 07:57:30 PM (10 months ago)

Author:

jorbin

Message:

Themes: Remove memoization from stylesheet and theme directories.

This fixes bugs introduced in [56635] whereby the template or stylesheet path could be memoized incorrectly if get_template_directory() or get_stylesheet_directory() were called before the theme has been fully initialized.

Reviewed by Jorbin.
Merges [57129] to 6.4 branch.

Props partyfrikadelle, coreyw, kdowns, rebasaurus, meta4, flixos90, mukesh27, joemcgill, icaleb.
Fixes #59847.

Location:

branches/6.4

Files:

• . (modified) (1 prop)
• src/wp-includes/ms-blogs.php (modified) (4 diffs)
• src/wp-includes/theme.php (modified) (4 diffs)
• tests/phpunit/data/themedir2 (copied) (copied from trunk/tests/phpunit/data/themedir2)
• 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
  *
@@ -535 +533 @@
 
     $wpdb->set_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;
+    $GLOBALS['table_prefix'] = $wpdb->get_blog_prefix();
+    $GLOBALS['blog_id']      = $new_blog_id;
 
     if ( function_exists( 'wp_cache_switch_to_blog' ) ) {
@@ -605 +601 @@
  * @global bool            $switched
  * @global string          $table_prefix
- * @global string          $wp_template_path
- * @global string          $wp_stylesheet_path
  * @global WP_Object_Cache $wp_object_cache
  *
@@ -632 +626 @@
 
     $wpdb->set_blog_id( $new_blog_id );
-    $GLOBALS['blog_id']            = $new_blog_id;
-    $GLOBALS['table_prefix']       = $wpdb->get_blog_prefix();
-    $GLOBALS['wp_template_path']   = null;
-    $GLOBALS['wp_stylesheet_path'] = null;
+    $GLOBALS['blog_id']      = $new_blog_id;
+    $GLOBALS['table_prefix'] = $wpdb->get_blog_prefix();
 
     if ( function_exists( 'wp_cache_switch_to_blog' ) ) {

branches/6.4/src/wp-includes/theme.php

@@ -189 +189 @@
  * @since 1.5.0
  * @since 6.4.0 Memoizes filter execution so that it only runs once for the current theme.
- *
- * @global string $wp_stylesheet_path Current theme stylesheet directory path.
+ * @since 6.4.2 Memoization removed.
  *
  * @return string Path to active theme's stylesheet directory.
  */
 function get_stylesheet_directory() {
-    global $wp_stylesheet_path;
-
-    if ( null === $wp_stylesheet_path ) {
-        $stylesheet     = get_stylesheet();
-        $theme_root     = get_theme_root( $stylesheet );
-        $stylesheet_dir = "$theme_root/$stylesheet";
-
-        /**
-         * Filters the stylesheet directory path for the active theme.
-         *
-         * @since 1.5.0
-         *
-         * @param string $stylesheet_dir Absolute path to the active theme.
-         * @param string $stylesheet     Directory name of the active theme.
-         * @param string $theme_root     Absolute path to themes directory.
-         */
-        $stylesheet_dir = apply_filters( 'stylesheet_directory', $stylesheet_dir, $stylesheet, $theme_root );
-
-        // If there are filter callbacks, force the logic to execute on every call.
-        if ( has_filter( 'stylesheet' ) || has_filter( 'theme_root' ) || has_filter( 'stylesheet_directory' ) ) {
-            return $stylesheet_dir;
-        }
-
-        $wp_stylesheet_path = $stylesheet_dir;
-    }
-
-    return $wp_stylesheet_path;
+    $stylesheet     = get_stylesheet();
+    $theme_root     = get_theme_root( $stylesheet );
+    $stylesheet_dir = "$theme_root/$stylesheet";
+
+    /**
+     * Filters the stylesheet directory path for the active theme.
+     *
+     * @since 1.5.0
+     *
+     * @param string $stylesheet_dir Absolute path to the active theme.
+     * @param string $stylesheet     Directory name of the active theme.
+     * @param string $theme_root     Absolute path to themes directory.
+     */
+    return apply_filters( 'stylesheet_directory', $stylesheet_dir, $stylesheet, $theme_root );
 }
 
@@ -339 +325 @@
  * @since 1.5.0
  * @since 6.4.0 Memoizes filter execution so that it only runs once for the current theme.
- *
- * @global string $wp_template_path Current theme template directory path.
+ * @since 6.4.1 Memoization removed.
  *
  * @return string Path to active theme's template directory.
  */
 function get_template_directory() {
-    global $wp_template_path;
-
-    if ( null === $wp_template_path ) {
-        $template     = get_template();
-        $theme_root   = get_theme_root( $template );
-        $template_dir = "$theme_root/$template";
-
-        /**
-         * Filters the active theme directory path.
-         *
-         * @since 1.5.0
-         *
-         * @param string $template_dir The path of the active theme directory.
-         * @param string $template     Directory name of the active theme.
-         * @param string $theme_root   Absolute path to the themes directory.
-         */
-        $template_dir = apply_filters( 'template_directory', $template_dir, $template, $theme_root );
-
-        // If there are filter callbacks, force the logic to execute on every call.
-        if ( has_filter( 'template' ) || has_filter( 'theme_root' ) || has_filter( 'template_directory' ) ) {
-            return $template_dir;
-        }
-
-        $wp_template_path = $template_dir;
-    }
-
-    return $wp_template_path;
+    $template     = get_template();
+    $theme_root   = get_theme_root( $template );
+    $template_dir = "$theme_root/$template";
+
+    /**
+     * Filters the active theme directory path.
+     *
+     * @since 1.5.0
+     *
+     * @param string $template_dir The path of the active theme directory.
+     * @param string $template     Directory name of the active theme.
+     * @param string $theme_root   Absolute path to the themes directory.
+     */
+    return apply_filters( 'template_directory', $template_dir, $template, $theme_root );
 }
 
@@ -777 +749 @@
  * @global array                $sidebars_widgets
  * @global array                $wp_registered_sidebars
- * @global string               $wp_stylesheet_path
- * @global string               $wp_template_path
  *
  * @param string $stylesheet Stylesheet name.
  */
 function switch_theme( $stylesheet ) {
-    global $wp_theme_directories, $wp_customize, $sidebars_widgets, $wp_registered_sidebars, $wp_stylesheet_path, $wp_template_path;
+    global $wp_theme_directories, $wp_customize, $sidebars_widgets, $wp_registered_sidebars;
 
     $requirements = validate_theme_requirements( $stylesheet );
@@ -866 +836 @@
 
     update_option( 'theme_switched', $old_theme->get_stylesheet() );
-
-    /*
-     * Reset globals to force refresh the next time these directories are
-     * accessed via `get_stylesheet_directory()` / `get_template_directory()`.
-     */
-    $wp_stylesheet_path = null;
-    $wp_template_path   = null;
 
     // Clear pattern caches.

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

@@ -1180 +1180 @@
         }
     }
+
+    /**
+     * Make sure filters added after the initial call are fired.
+     *
+     * @ticket 59847
+     *
+     * @covers ::get_stylesheet_directory
+     */
+    public function test_get_stylesheet_directory_filters_apply() {
+        // Call the function prior to the filter being added.
+        get_stylesheet_directory();
+
+        $expected = 'test_root/dir';
+
+        // Add the filer.
+        add_filter(
+            'stylesheet_directory',
+            function () use ( $expected ) {
+                return $expected;
+            }
+        );
+
+        $this->assertSame( $expected, get_stylesheet_directory() );
+    }
+
+    /**
+     * Make sure filters added after the initial call are fired.
+     *
+     * @ticket 59847
+     *
+     * @covers ::get_template_directory
+     */
+    public function test_get_template_directory_filters_apply() {
+        // Call the function prior to the filter being added.
+        get_template_directory();
+
+        $expected = 'test_root/dir';
+
+        // Add the filer.
+        add_filter(
+            'template_directory',
+            function () use ( $expected ) {
+                return $expected;
+            }
+        );
+
+        $this->assertSame( $expected, get_template_directory() );
+    }
+
+    /**
+     * Make sure get_stylesheet_directory uses the correct path when the root theme dir changes.
+     *
+     * @ticket 59847
+     *
+     * @covers ::get_stylesheet_directory
+     */
+    public function test_get_stylesheet_directory_uses_registered_theme_dir() {
+        $old_theme = wp_get_theme();
+
+        switch_theme( 'test' );
+
+        $old_root = get_theme_root( 'test' );
+        $path1    = get_stylesheet_directory();
+
+        $new_root = DIR_TESTDATA . '/themedir2';
+        register_theme_directory( $new_root );
+
+        // Mock the stylesheet root option to mimic that the active root has changed.
+        add_filter(
+            'pre_option_stylesheet_root',
+            function () use ( $new_root ) {
+                return $new_root;
+            }
+        );
+
+        $path2 = get_stylesheet_directory();
+
+        // Cleanup.
+        switch_theme( $old_theme->get_stylesheet() );
+
+        $this->assertEquals( $old_root . '/test', $path1, 'The original stylesheet path is not correct' );
+        $this->assertEquals( $new_root . '/test', $path2, 'The new stylesheet path is not correct' );
+    }
+
+    /**
+     * Make sure get_template_directory uses the correct path when the root theme dir changes.
+     *
+     * @ticket 59847
+     *
+     * @covers ::get_template_directory
+     */
+    public function test_get_template_directory_uses_registered_theme_dir() {
+        $old_theme = wp_get_theme();
+
+        switch_theme( 'test' );
+
+        // Mock parent theme to be returned as the template.
+        add_filter(
+            'pre_option_template',
+            function () {
+                return 'test-parent';
+            }
+        );
+
+        $old_root = get_theme_root( 'test' );
+        $path1    = get_template_directory();
+
+        $new_root = DIR_TESTDATA . '/themedir2';
+        register_theme_directory( $new_root );
+
+        // Mock the template root option to mimic that the active root has changed.
+        add_filter(
+            'pre_option_template_root',
+            function () use ( $new_root ) {
+                return $new_root;
+            }
+        );
+
+        $path2 = get_template_directory();
+
+        // Cleanup.
+        switch_theme( $old_theme->get_stylesheet() );
+
+        $this->assertEquals( $old_root . '/test-parent', $path1, 'The original template path is not correct' );
+        $this->assertEquals( $new_root . '/test-parent', $path2, 'The new template path is not correct' );
+    }
 }