Changeset 56818

Timestamp:

10/10/2023 01:19:42 PM (18 months ago)

Author:

Bernhard Reiter

Message:

Patterns: Inject theme attribute into Template Part blocks.

[56805] introduced a regression: The theme attribute was no longer injected into Template Part blocks inside of patterns. This caused errors on the frontend, where instead of a given template part, an error message such as Template part has been deleted or is unavailable: header was seen.

This changeset rectifies that problem, and adds unit test coverage to guard against future regressions.

Follow-up to [56805].
Props scruffian, gziolo.
Fixes #59583.

Location:

trunk

Files:

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

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

@@ -165 +165 @@
     private function prepare_content( $pattern, $hooked_blocks ) {
         $content = $pattern['content'];
+
+        $before_block_visitor = '_inject_theme_attribute_in_template_part_block';
+        $after_block_visitor  = null;
         if ( ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ) ) {
-            $blocks               = parse_blocks( $content );
             $before_block_visitor = make_before_block_visitor( $hooked_blocks, $pattern );
             $after_block_visitor  = make_after_block_visitor( $hooked_blocks, $pattern );
-            $content              = traverse_and_serialize_blocks( $blocks, $before_block_visitor, $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/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.
      *
@@ -370 +393 @@
 
     /**
+     * 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.
      *