Patterns, Templates: Inject theme attr into Template Part blocks.

It was found that Template Part blocks were broken in the Site Editor, showing the `Template part has been deleted or is unavailable` message, due to a missing `theme` attribute. This bug seems to have been introduced by [56896], whose goal was to only inject that attribute into the markup returned by the templates and patterns REST API endpoints but not on the frontend, in order to improve performance. It has been demonstrated locally that reverting that changeset fixes the bug. Reverts [56896]. Props mmcalister, swisspidy, thelovelist, hellofromTonya, pbiron, Pauthake015, richtabor, nicolefurlan, huzaifaalmesbah, annezazu, kafleg, aegkr, sunitarai, shresthaaman, andraganescu, onemaggie, gziolo. Fixes #59629. git-svn-id: https://develop.svn.wordpress.org/trunk@56960 602fd350-edb4-49c9-b593-d223f7449a82
WordPress · Oct 17, 2023 · dcd6e5c · dcd6e5c
1 parent 7856fcb
commit dcd6e5c
Show file tree

Hide file tree

Showing 6 changed files with 111 additions and 135 deletions.
diff --git a/src/wp-includes/block-template-utils.php b/src/wp-includes/block-template-utils.php
@@ -547,18 +547,15 @@ function _build_block_template_result_from_file( $template_file, $template_type
 		$template->area = $template_file['area'];
 	}
 
-	$before_block_visitor = ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ? '_inject_theme_attribute_in_template_part_block' : null;
+	$before_block_visitor = '_inject_theme_attribute_in_template_part_block';
 	$after_block_visitor  = null;
 	$hooked_blocks        = get_hooked_blocks();
 	if ( ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ) ) {
 		$before_block_visitor = make_before_block_visitor( $hooked_blocks, $template );
 		$after_block_visitor  = make_after_block_visitor( $hooked_blocks, $template );
 	}
-	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;
+	$blocks            = parse_blocks( $template_content );
+	$template->content = traverse_and_serialize_blocks( $blocks, $before_block_visitor, $after_block_visitor );
 
 	return $template;
 }

diff --git a/src/wp-includes/blocks.php b/src/wp-includes/blocks.php
@@ -779,9 +779,7 @@ function make_before_block_visitor( $hooked_blocks, $context ) {
 	 * @return string The serialized markup for the given block, with the markup for any hooked blocks prepended to it.
 	 */
 	return function ( &$block, $parent_block = null, $prev = null ) use ( $hooked_blocks, $context ) {
-		if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
-			_inject_theme_attribute_in_template_part_block( $block );
-		}
+		_inject_theme_attribute_in_template_part_block( $block );
 
 		$markup = '';
 

diff --git a/src/wp-includes/class-wp-block-patterns-registry.php b/src/wp-includes/class-wp-block-patterns-registry.php
@@ -165,16 +165,14 @@ public function unregister( $pattern_name ) {
 	private function prepare_content( $pattern, $hooked_blocks ) {
 		$content = $pattern['content'];
 
-		$before_block_visitor = ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ? '_inject_theme_attribute_in_template_part_block' : null;
+		$before_block_visitor = '_inject_theme_attribute_in_template_part_block';
 		$after_block_visitor  = null;
 		if ( ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ) ) {
 			$before_block_visitor = make_before_block_visitor( $hooked_blocks, $pattern );
 			$after_block_visitor  = make_after_block_visitor( $hooked_blocks, $pattern );
 		}
-		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 );
-		}
+		$blocks  = parse_blocks( $content );
+		$content = traverse_and_serialize_blocks( $blocks, $before_block_visitor, $after_block_visitor );
 
 		return $content;
 	}

diff --git a/tests/phpunit/tests/block-template-utils.php b/tests/phpunit/tests/block-template-utils.php
@@ -161,6 +161,64 @@ public function test_build_block_template_result_from_file() {
 		$this->assertEmpty( $template_part->modified );
 	}
 
+	/**
+	 * @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
 	 *

diff --git a/tests/phpunit/tests/blocks/renderBlockCoreTemplatePart.php b/tests/phpunit/tests/blocks/renderBlockCoreTemplatePart.php
diff --git a/tests/phpunit/tests/blocks/wpBlockPatternsRegistry.php b/tests/phpunit/tests/blocks/wpBlockPatternsRegistry.php
@@ -316,6 +316,29 @@ public function test_get_registered() {
 		$this->assertSame( $pattern_two, $pattern );
 	}
 
+	/**
+	 * 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.
 	 *
@@ -368,6 +391,29 @@ public function test_get_all_registered_includes_hooked_blocks() {
 		$this->assertSame( $expected, $registered );
 	}
 
+	/**
+	 * 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.
 	 *