Changeset 57944

Timestamp:

04/08/2024 04:45:22 PM (5 months ago)

Author:

jorgefilipecosta

Message:

Honor template_hierarchy filters when creating a template in the Site Editor.

Currently, in blocks themes it's possible to use the ${type}_template_hierarchy filter to alter the template hierarchy. However, those filters are not taken into consideration by the Choose a pattern popup screen that appears when creating a new template in the Site Editor, causing a mismatch between the editor and the frontend.

Props aljullu, mukesh27, ntsekouras, jorgefilipecosta, gziolo.
Fixes #60846.

Location:

trunk

Files:

• src/wp-includes/block-template-utils.php (modified) (2 diffs)
• tests/phpunit/tests/block-templates/getTemplateHierarchy.php (modified) (1 diff)

trunk/src/wp-includes/block-template-utils.php

@@ -1398 +1398 @@
 function get_template_hierarchy( $slug, $is_custom = false, $template_prefix = '' ) {
     if ( 'index' === $slug ) {
-        return array( 'index' );
+        /** This filter is documented in wp-includes/template.php */
+        return apply_filters( 'index_template_hierarchy', array( 'index' ) );
     }
     if ( $is_custom ) {
-        return array( 'page', 'singular', 'index' );
+        /** This filter is documented in wp-includes/template.php */
+        return apply_filters( 'page_template_hierarchy', array( 'page', 'singular', 'index' ) );
     }
     if ( 'front-page' === $slug ) {
-        return array( 'front-page', 'home', 'index' );
+        /** This filter is documented in wp-includes/template.php */
+        return apply_filters( 'frontpage_template_hierarchy', array( 'front-page', 'home', 'index' ) );
     }
 
@@ -1470 +1473 @@
     }
     $template_hierarchy[] = 'index';
+
+    $template_type = '';
+    if ( ! empty( $template_prefix ) ) {
+        list( $template_type ) = explode( '-', $template_prefix );
+    } else {
+        list( $template_type ) = explode( '-', $slug );
+    }
+    $valid_template_types = array( '404', 'archive', 'attachment', 'author', 'category', 'date', 'embed', 'frontpage', 'home', 'index', 'page', 'paged', 'privacypolicy', 'search', 'single', 'singular', 'tag', 'taxonomy' );
+    if ( in_array( $template_type, $valid_template_types ) ) {
+        /** This filter is documented in wp-includes/template.php */
+        return apply_filters( "{$template_type}_template_hierarchy", $template_hierarchy );
+    }
     return $template_hierarchy;
 }

trunk/tests/phpunit/tests/block-templates/getTemplateHierarchy.php

@@ -42 +42 @@
 
     /**
+     * @ticket 60846
+     */
+    public function test_get_template_hierarchy_with_hooks() {
+        add_filter(
+            'date_template_hierarchy',
+            function ( $templates ) {
+                return array_merge( array( 'date-custom' ), $templates );
+            }
+        );
+        $expected = array( 'date-custom', 'date', 'archive', 'index' );
+        $this->assertSame( $expected, get_template_hierarchy( 'date' ) );
+    }
+
+    /**
      * Data provider.
      *