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

Timestamp:

09/20/2023 05:25:26 PM (18 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/template.php (modified) (3 diffs)

trunk/src/wp-includes/template.php

@@ -685 +685 @@
  * Retrieves the name of the highest priority template file that exists.
  *
- * Searches in the STYLESHEETPATH before TEMPLATEPATH and wp-includes/theme-compat
- * so that themes which inherit from a parent theme can just overload one file.
+ * Searches in the stylesheet directory before the template directory and
+ * wp-includes/theme-compat so that themes which inherit from a parent theme
+ * can just overload one file.
  *
  * @since 2.7.0
@@ -700 +701 @@
  */
 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;
+
     $located = '';
     foreach ( (array) $template_names as $template_name ) {
@@ -705 +710 @@
             continue;
         }
-        if ( file_exists( STYLESHEETPATH . '/' . $template_name ) ) {
-            $located = STYLESHEETPATH . '/' . $template_name;
+        if ( file_exists( $stylesheet_path . '/' . $template_name ) ) {
+            $located = $stylesheet_path . '/' . $template_name;
             break;
-        } elseif ( is_child_theme() && file_exists( TEMPLATEPATH . '/' . $template_name ) ) {
-            $located = TEMPLATEPATH . '/' . $template_name;
+        } elseif ( $is_child_theme && file_exists( $template_path . '/' . $template_name ) ) {
+            $located = $template_path . '/' . $template_name;
             break;
         } elseif ( file_exists( ABSPATH . WPINC . '/theme-compat/' . $template_name ) ) {