Changeset 56635 for trunk/src/wp-includes/theme.php

Timestamp:

09/20/2023 05:25:26 PM (13 months ago)

Author:

flixos90

Message:

Themes: Deprecate usage of TEMPLATEPATH and STYLESHEETPATH constants.

While generally the functions get_template_directory() and get_stylesheet_directory() were long recommended to use to get the parent or child theme directory, the TEMPLATEPATH and STYLESHEETPATH constants were still used in a few places in core, most importantly in template related logic.

The remaining usage was problematic as it prevented testability of certain key components of WordPress core.

This changeset replaces all remaining usage with the corresponding functions and effectively marks these constants as deprecated. It also adds test coverage accordingly and even unlocks some existing, previously commented out test coverage to work as expected.

Performance of the new approach has been benchmarked and shows no notable differences. Yet, given that the current theme directories are not expected to change within a regular WordPress page load, the get_template_directory() and get_stylesheet_directory() functions were amended with in-memory caching of the result, unless one of the defining values is being filtered.

Props thekt12, spacedmonkey, mukesh27, aaroncampbell, scribu, lloydbudd, cais, chipbennett, toscho, omarabid, CrazyJaco, DrewAPicture, obenland, wonderboymusic, nacin, helen, dd32, chriscct7, SergeyBiryukov, swissspidy, joemcgill, flixos90.
Fixes #18298.

File:

• trunk/src/wp-includes/theme.php (modified) (5 diffs)

trunk/src/wp-includes/theme.php

@@ -158 +158 @@
  */
 function is_child_theme() {
-    return ( TEMPLATEPATH !== STYLESHEETPATH );
+    return get_template_directory() !== get_stylesheet_directory();
 }
 
@@ -188 +188 @@
  *
  * @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.
  *
  * @return string Path to active theme's stylesheet directory.
  */
 function get_stylesheet_directory() {
-    $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 );
+    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;
 }
 
@@ -322 +338 @@
  *
  * @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.
  *
  * @return string Path to active theme's template directory.
  */
 function get_template_directory() {
-    $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 );
+    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;
 }
 
@@ -745 +777 @@
  * @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;
+    global $wp_theme_directories, $wp_customize, $sidebars_widgets, $wp_registered_sidebars, $wp_stylesheet_path, $wp_template_path;
 
     $requirements = validate_theme_requirements( $stylesheet );
@@ -832 +866 @@
 
     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;
 
     /**