Changeset 56896

Timestamp:

10/12/2023 04:39:27 PM (14 months ago)

Author:

Bernhard Reiter

Message:

Patterns: Don't inject theme attribute on frontend.

Having the patterns registry inject the theme attribute into all Template Part blocks inside every pattern was found to negatively impact performance. It turns out that it's only required for the editor (i.e. in the REST API) but not on the frontend; there, it's instead possible to fall back to the currently active theme.

The latter change was made to the Pattern and Template Part blocks in ​https://github.com/WordPress/gutenberg/pull/55217, which was sync'ed to Core in [56849]. Consequently, this changeset removes theme attribute insertion from the frontend.

Props flixos90, gziolo, dmsnell, hellofromtonya.
Fixes #59583.

Location:

trunk

Files:

• src/wp-includes/block-template-utils.php (modified) (2 diffs)
• src/wp-includes/blocks.php (modified) (1 diff)
• src/wp-includes/class-wp-block-patterns-registry.php (modified) (2 diffs)
• tests/phpunit/tests/block-template-utils.php (modified) (1 diff)
• tests/phpunit/tests/blocks/renderBlockCoreTemplatePart.php (added)
• tests/phpunit/tests/blocks/wpBlockPatternsRegistry.php (modified) (2 diffs)

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

@@ -550 +550 @@
     }
 
-    $before_block_visitor = '_inject_theme_attribute_in_template_part_block';
+    $before_block_visitor = ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ? '_inject_theme_attribute_in_template_part_block' : null;
     $after_block_visitor  = null;
     $hooked_blocks        = get_hooked_blocks();
@@ -557 +557 @@
         $after_block_visitor  = make_after_block_visitor( $hooked_blocks, $template );
     }
-    $blocks            = parse_blocks( $template_content );
-    $template->content = traverse_and_serialize_blocks( $blocks, $before_block_visitor, $after_block_visitor );
+    if ( null !== $before_block_visitor || null !== $after_block_visitor ) {
+        $blocks           = parse_blocks( $template_content );
+        $template_content = traverse_and_serialize_blocks( $blocks, $before_block_visitor, $after_block_visitor );
+    }
+    $template->content = $template_content;
 
     return $template;

trunk/src/wp-includes/blocks.php

@@ -780 +780 @@
      */
     return function ( &$block, $parent_block = null, $prev = null ) use ( $hooked_blocks, $context ) {
-        _inject_theme_attribute_in_template_part_block( $block );
+        if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
+            _inject_theme_attribute_in_template_part_block( $block );
+        }
 
         $markup = '';

trunk/src/wp-includes/class-wp-block-patterns-registry.php

@@ -166 +166 @@
         $content = $pattern['content'];
 
-        $before_block_visitor = '_inject_theme_attribute_in_template_part_block';
+        $before_block_visitor = ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ? '_inject_theme_attribute_in_template_part_block' : null;
         $after_block_visitor  = null;
         if ( ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ) ) {
@@ -172 +172 @@
             $after_block_visitor  = make_after_block_visitor( $hooked_blocks, $pattern );
         }
-        $blocks  = parse_blocks( $content );
-        $content = traverse_and_serialize_blocks( $blocks, $before_block_visitor, $after_block_visitor );
+        if ( null !== $before_block_visitor || null !== $after_block_visitor ) {
+            $blocks  = parse_blocks( $content );
+            $content = traverse_and_serialize_blocks( $blocks, $before_block_visitor, $after_block_visitor );
+        }
 
         return $content;

trunk/tests/phpunit/tests/block-template-utils.php

@@ -163 +163 @@
 
     /**
-     * @ticket 59325
-     *
-     * @covers ::_build_block_template_result_from_file
-     *
-     * @dataProvider data_build_block_template_result_from_file_injects_theme_attribute
-     *
-     * @param string $filename The template's filename.
-     * @param string $expected The expected block markup.
-     */
-    public function test_build_block_template_result_from_file_injects_theme_attribute( $filename, $expected ) {
-        $template = _build_block_template_result_from_file(
-            array(
-                'slug' => 'single',
-                'path' => DIR_TESTDATA . "/templates/$filename",
-            ),
-            'wp_template'
-        );
-        $this->assertSame( $expected, $template->content );
-    }
-
-    /**
-     * Data provider.
-     *
-     * @return array[]
-     */
-    public function data_build_block_template_result_from_file_injects_theme_attribute() {
-        $theme = 'block-theme';
-        return array(
-            'a template with a template part block'  => array(
-                'filename' => 'template-with-template-part.html',
-                'expected' => sprintf(
-                    '<!-- wp:template-part {"slug":"header","align":"full","tagName":"header","className":"site-header","theme":"%s"} /-->',
-                    $theme
-                ),
-            ),
-            'a template with a template part block nested inside another block' => array(
-                'filename' => 'template-with-nested-template-part.html',
-                'expected' => sprintf(
-                    '<!-- wp:group -->
-<!-- wp:template-part {"slug":"header","align":"full","tagName":"header","className":"site-header","theme":"%s"} /-->
-<!-- /wp:group -->',
-                    $theme
-                ),
-            ),
-            'a template with a template part block with an existing theme attribute' => array(
-                'filename' => 'template-with-template-part-with-existing-theme-attribute.html',
-                'expected' => '<!-- wp:template-part {"slug":"header","theme":"fake-theme","align":"full","tagName":"header","className":"site-header"} /-->',
-            ),
-            'a template with no template part block' => array(
-                'filename' => 'template.html',
-                'expected' => '<!-- wp:paragraph -->
-<p>Just a paragraph</p>
-<!-- /wp:paragraph -->',
-            ),
-        );
-    }
-
-    /**
      * @ticket 59338
      *

trunk/tests/phpunit/tests/blocks/wpBlockPatternsRegistry.php

@@ -318 +318 @@
 
     /**
-     * Should insert a theme attribute into Template Part blocks in registered patterns.
-     *
-     * @ticket 59583
-     *
-     * @covers WP_Block_Patterns_Registry::register
-     * @covers WP_Block_Patterns_Registry::get_all_registered
-     */
-    public function test_get_all_registered_includes_theme_attribute() {
-        $test_pattern = array(
-            'title'   => 'Test Pattern',
-            'content' => '<!-- wp:template-part {"slug":"header","align":"full","tagName":"header","className":"site-header"} /-->',
-        );
-        $this->registry->register( 'test/pattern', $test_pattern );
-
-        $expected = sprintf(
-            '<!-- wp:template-part {"slug":"header","align":"full","tagName":"header","className":"site-header","theme":"%s"} /-->',
-            get_stylesheet()
-        );
-        $patterns = $this->registry->get_all_registered();
-        $this->assertSame( $expected, $patterns[0]['content'] );
-    }
-
-    /**
      * Should insert hooked blocks into registered patterns.
      *
@@ -393 +370 @@
 
     /**
-     * Should insert a theme attribute into Template Part blocks in registered patterns.
-     *
-     * @ticket 59583
-     *
-     * @covers WP_Block_Patterns_Registry::register
-     * @covers WP_Block_Patterns_Registry::get_registered
-     */
-    public function test_get_registered_includes_theme_attribute() {
-        $test_pattern = array(
-            'title'   => 'Test Pattern',
-            'content' => '<!-- wp:template-part {"slug":"header","align":"full","tagName":"header","className":"site-header"} /-->',
-        );
-        $this->registry->register( 'test/pattern', $test_pattern );
-
-        $expected = sprintf(
-            '<!-- wp:template-part {"slug":"header","align":"full","tagName":"header","className":"site-header","theme":"%s"} /-->',
-            get_stylesheet()
-        );
-        $pattern  = $this->registry->get_registered( 'test/pattern' );
-        $this->assertSame( $expected, $pattern['content'] );
-    }
-
-    /**
      * Should insert hooked blocks into registered patterns.
      *