Changeset 59951

Timestamp:

03/07/2025 05:53:37 PM (2 weeks ago)

Author:

flixos90

Message:

Editor: Fix unexpected behavior due to conflicting custom block template.

This changeset fixes both a visual and functional bug related to template selection in the editor that occurred when having a custom block template registered that was using the same slug as another block template already registered by the theme, including the default block templates.

Props aljullu, antonvlasenko, apermo, audrasjb, azaozz, ntsekouras.
Fixes #62319.

Location:

trunk

Files:

• src/wp-includes/block-template-utils.php (modified) (1 diff)
• tests/phpunit/tests/blocks/getBlockTemplates.php (modified) (1 diff)

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

@@ -1186 +1186 @@
          */
         $query['slug__not_in'] = wp_list_pluck( $query_result, 'slug' );
-        $template_files        = _get_block_templates_files( $template_type, $query );
+        /*
+         * We need to unset the post_type query param because some templates
+         * would be excluded otherwise, like `page.html` when looking for
+         * `page` templates. We need all templates so we can exclude duplicates
+         * from plugin-registered templates.
+         * See: https://github.com/WordPress/gutenberg/issues/65584
+         */
+        $template_files_query = $query;
+        unset( $template_files_query['post_type'] );
+        $template_files = _get_block_templates_files( $template_type, $template_files_query );
         foreach ( $template_files as $template_file ) {
-            $query_result[] = _build_block_template_result_from_file( $template_file, $template_type );
+            // If the query doesn't specify a post type, or it does and the template matches the post type, add it.
+            if (
+                ! isset( $query['post_type'] ) ||
+                (
+                    isset( $template_file['postTypes'] ) &&
+                    in_array( $query['post_type'], $template_file['postTypes'], true )
+                )
+            ) {
+                $query_result[] = _build_block_template_result_from_file( $template_file, $template_type );
+            } elseif ( ! isset( $template_file['postTypes'] ) ) {
+                // The custom templates with no associated post types are available for all post types as long
+                // as they are not default templates.
+                $candidate              = _build_block_template_result_from_file( $template_file, $template_type );
+                $default_template_types = get_default_block_template_types();
+                if ( ! isset( $default_template_types[ $candidate->slug ] ) ) {
+                    $query_result[] = $candidate;
+                }
+            }
         }
 

trunk/tests/phpunit/tests/blocks/getBlockTemplates.php

@@ -229 +229 @@
         );
     }
+
+    /**
+     * @dataProvider data_get_block_templates_should_not_leak_plugin_registered_templates_with_default_post_type_slugs
+     * @ticket 62319
+     *
+     * @covers ::get_block_templates
+     *
+     * @param string $template_slug Default slug for the post type.
+     * @param string $post_type     Post type for query.
+     * @param array  $expected      Expected template IDs.
+     */
+    public function test_get_block_templates_should_not_leak_plugin_registered_templates_with_default_post_type_slugs( $template_slug, $post_type, $expected ) {
+        $template_name = 'test-plugin//' . $template_slug;
+        $template_args = array(
+            'content'     => 'Template content',
+            'title'       => 'Test Template for ' . $post_type,
+            'description' => 'Description of test template',
+            'post_types'  => array( $post_type ),
+        );
+        register_block_template( $template_name, $template_args );
+
+        $templates = get_block_templates( array( 'post_type' => $post_type ) );
+
+        $this->assertSameSets(
+            $expected,
+            $this->get_template_ids( $templates )
+        );
+
+        unregister_block_template( $template_name );
+    }
+
+    /**
+     * Data provider.
+     *
+     * Make sure that plugin-registered templates with default post type slugs (ie: `single` or `page`)
+     * don't leak into `get_block_templates()`.
+     * See: https://core.trac.wordpress.org/ticket/62319.
+     *
+     * @return array
+     */
+    public function data_get_block_templates_should_not_leak_plugin_registered_templates_with_default_post_type_slugs() {
+        return array(
+            'post' => array(
+                'template_slug' => 'single',
+                'post_type'     => 'post',
+                'expected'      => array(
+                    'block-theme//custom-hero-template',
+                    'block-theme//custom-single-post-template',
+                ),
+            ),
+            'page' => array(
+                'template_slug' => 'page',
+                'post_type'     => 'page',
+                'expected'      => array(
+                    'block-theme//custom-hero-template',
+                    'block-theme//page-home',
+                ),
+            ),
+        );
+    }
 }