Changeset 56578

Timestamp:

09/14/2023 08:50:43 AM (20 months ago)

Author:

Bernhard Reiter

Message:

Themes: Inject theme attribute during serialization.

Rather than using _inject_theme_attribute_in_block_template_content to inject the theme attribute into all Template Part blocks found in a given file-based Block Template, introduce a new function called _inject_theme_attribute_in_template_part_block, and use that as second argument to serialize_blocks() (introduced in [56557]) in order to inject said attribute during tree traversal for serialization.

This allows for a more modular approach that will eventually be extended to implement automatic insertion of hooked blocks.

Note that we're guarding _build_block_template_result_from_file() (i.e. the callsite of _inject_theme_attribute_in_template_part_block and previously of _inject_theme_attribute_in_block_template_content) against regressions through additional unit test coverage added in [56562].

Props @gziolo.
Fixes #59338. See #59313.

Location:

trunk

Files:

• src/wp-includes/block-template-utils.php (modified) (3 diffs)
• tests/phpunit/data/templates/template-with-template-part-with-existing-theme-attribute.html (modified) (1 diff)
• tests/phpunit/tests/block-template-utils.php (modified) (2 diffs)

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

@@ -515 +515 @@
 
 /**
+ * Injects the active theme's stylesheet as a `theme` attribute
+ * into a given template part block.
+ *
+ * @since 6.4.0
+ * @access private
+ *
+ * @param array $block a parsed block.
+ * @return array Updated block.
+ */
+function _inject_theme_attribute_in_template_part_block( $block ) {
+    if (
+        'core/template-part' === $block['blockName'] &&
+        ! isset( $block['attrs']['theme'] )
+    ) {
+        $block['attrs']['theme'] = get_stylesheet();
+    }
+    return $block;
+}
+
+/**
  * Parses a block template and removes the theme attribute from each template part.
  *
@@ -566 +586 @@
     $template->id             = $theme . '//' . $template_file['slug'];
     $template->theme          = $theme;
-    $template->content        = _inject_theme_attribute_in_block_template_content( $template_content );
     $template->slug           = $template_file['slug'];
     $template->source         = 'theme';
@@ -589 +608 @@
         $template->area = $template_file['area'];
     }
+
+    $blocks            = parse_blocks( $template_content );
+    $template->content = serialize_blocks( $blocks, '_inject_theme_attribute_in_template_part_block' );
 
     return $template;

trunk/tests/phpunit/data/templates/template-with-template-part-with-existing-theme-attribute.html

@@ -1 @@
-<!-- wp:template-part {"slug":"header","theme":"fake-theme","align":"full", "tagName":"header","className":"site-header"} /-->
+<!-- wp:template-part {"slug":"header","theme":"fake-theme","align":"full","tagName":"header","className":"site-header"} /-->

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

@@ -209 +209 @@
             '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"} /-->',
+                'expected' => '<!-- wp:template-part {"slug":"header","theme":"fake-theme","align":"full","tagName":"header","className":"site-header"} /-->',
             ),
             'a template with no template part block' => array(
@@ -217 +217 @@
 <!-- /wp:paragraph -->',
             ),
+        );
+    }
+
+    /**
+     * @ticket 59338
+     *
+     * @covers ::test_inject_theme_attribute_in_template_part_block
+     */
+    public function test_inject_theme_attribute_in_template_part_block() {
+        $template_part_block_without_theme_attribute = array(
+            'blockName'    => 'core/template-part',
+            'attrs'        => array(
+                'slug'      => 'header',
+                'align'     => 'full',
+                'tagName'   => 'header',
+                'className' => 'site-header',
+            ),
+            'innerHTML'    => '',
+            'innerContent' => array(),
+            'innerBlocks'  => array(),
+        );
+
+        $actual   = _inject_theme_attribute_in_template_part_block( $template_part_block_without_theme_attribute );
+        $expected = array(
+            'blockName'    => 'core/template-part',
+            'attrs'        => array(
+                'slug'      => 'header',
+                'align'     => 'full',
+                'tagName'   => 'header',
+                'className' => 'site-header',
+                'theme'     => get_stylesheet(),
+            ),
+            'innerHTML'    => '',
+            'innerContent' => array(),
+            'innerBlocks'  => array(),
+        );
+        $this->assertSame(
+            $expected,
+            $actual,
+            '`theme` attribute was not correctly injected in template part block.'
+        );
+
+        // Does not inject theme when there is an existing theme attribute.
+        $template_part_block_with_existing_theme_attribute = array(
+            'blockName'    => 'core/template-part',
+            'attrs'        => array(
+                'slug'      => 'header',
+                'align'     => 'full',
+                'tagName'   => 'header',
+                'className' => 'site-header',
+                'theme'     => 'fake-theme',
+            ),
+            'innerHTML'    => '',
+            'innerContent' => array(),
+            'innerBlocks'  => array(),
+        );
+
+        $actual = _inject_theme_attribute_in_template_part_block( $template_part_block_with_existing_theme_attribute );
+        $this->assertSame(
+            $template_part_block_with_existing_theme_attribute,
+            $actual,
+            'Existing `theme` attribute in template part block was not respected by attribute injection.'
+        );
+
+        // Does not inject theme when there is no template part.
+        $non_template_part_block = array(
+            'blockName'    => 'core/post-content',
+            'attrs'        => array(),
+            'innerHTML'    => '',
+            'innerContent' => array(),
+            'innerBlocks'  => array(),
+        );
+
+        $actual = _inject_theme_attribute_in_template_part_block( $non_template_part_block );
+        $this->assertSame(
+            $non_template_part_block,
+            $actual,
+            '`theme` attribute injection modified non-template-part block.'
         );
     }