mirror_php/wordpress
1
0
Fork 0
mirror of git://develop.git.wordpress.org/ synced 2025-04-13 08:32:10 +02:00
Code Issues Actions 11 Packages Projects Releases Wiki Activity

Patterns: Don't inject theme attribute on frontend.

Browse Source 
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.

git-svn-id: https://develop.svn.wordpress.org/trunk@56896 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Bernie Reiter 2023-10-12 16:39:27 +00:00
parent 871a496fb4
commit 33870e1924
6 changed files with 135 additions and 111 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/wp-includes/block-template-utils.php
View File

@ -549,15 +549,18 @@ function _build_block_template_result_from_file( $template_file, $template_type
$template->area = $template_file['area'];
}
$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();
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 );
}
$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;
}

4
src/wp-includes/blocks.php
View File

@ -779,7 +779,9 @@ 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 ) {
_inject_theme_attribute_in_template_part_block( $block );
if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
_inject_theme_attribute_in_template_part_block( $block );
}
$markup = '';

8
src/wp-includes/class-wp-block-patterns-registry.php
View File

@ -165,14 +165,16 @@ final class WP_Block_Patterns_Registry {
private function prepare_content( $pattern, $hooked_blocks ) {
$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' ) ) {
$before_block_visitor = make_before_block_visitor( $hooked_blocks, $pattern );
$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;
}

58
tests/phpunit/tests/block-template-utils.php
View File

@ -161,64 +161,6 @@ class Tests_Block_Template_Utils extends WP_UnitTestCase {
$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
*

121
tests/phpunit/tests/blocks/renderBlockCoreTemplatePart.php Normal file
View File

@ -0,0 +1,121 @@
<?php
/**
* Tests for `render_block_core_template_part()`.
*
* @package WordPress
* @subpackage Blocks
*
* @group blocks
*/
class Tests_Blocks_RenderBlockCoreTemplatePart extends WP_UnitTestCase {
/**
* Temporary storage for original block to render.
*
* @var array|null
*/
private $original_block_to_render = null;
/**
* Flag to indicate whether to switch back to the default theme at tear down.
*
* @var bool
*/
private $switch_to_default_theme_at_teardown = false;
public function set_up() {
parent::set_up();
$this->original_block_to_render = WP_Block_Supports::$block_to_render;
}
public function tear_down() {
WP_Block_Supports::$block_to_render = $this->original_block_to_render;
$this->original_block_to_render = null;
if ( $this->switch_to_default_theme_at_teardown ) {
$this->switch_to_default_theme_at_teardown = false;
switch_theme( WP_DEFAULT_THEME );
}
parent::tear_down();
}
/**
* Tests that the core template part block assumes the current theme if no theme attribute provided.
*
* @ticket 59583
*/
public function test_render_block_core_template_part_without_theme_attribute() {
$this->maybe_switch_theme( 'block-theme' );
WP_Block_Supports::$block_to_render = array( 'blockName' => 'core/template-part' );
$content = render_block_core_template_part( array( 'slug' => 'small-header' ) );
$expected = '<header class="wp-block-template-part">' . "\n";
$expected .= '<p>Small Header Template Part</p>' . "\n";
$expected .= '</header>';
$this->assertSame( $expected, $content );
}
/**
* Tests that the core template part block returns the relevant part if current theme attribute provided.
*
* @ticket 59583
*/
public function test_render_block_core_template_part_with_current_theme_attribute() {
$this->maybe_switch_theme( 'block-theme' );
WP_Block_Supports::$block_to_render = array( 'blockName' => 'core/template-part' );
$content = render_block_core_template_part(
array(
'slug' => 'small-header',
'theme' => 'block-theme',
)
);
$expected = '<header class="wp-block-template-part">' . "\n";
$expected .= '<p>Small Header Template Part</p>' . "\n";
$expected .= '</header>';
$this->assertSame( $expected, $content );
}
/**
* Tests that the core template part block returns nothing if theme attribute for a different theme provided.
*
* @ticket 59583
*/
public function test_render_block_core_template_part_with_another_theme_attribute() {
$this->maybe_switch_theme( 'block-theme' );
WP_Block_Supports::$block_to_render = array( 'blockName' => 'core/template-part' );
$content = render_block_core_template_part(
array(
'slug' => 'small-header',
'theme' => WP_DEFAULT_THEME,
)
);
$expected = 'Template part has been deleted or is unavailable: small-header';
$this->assertSame( $expected, $content );
}
/**
* Switches the theme when not the default theme.
*
* @param string $theme Theme name to switch to.
*/
private function maybe_switch_theme( $theme ) {
if ( WP_DEFAULT_THEME === $theme ) {
return;
}
switch_theme( $theme );
$this->switch_to_default_theme_at_teardown = true;
}
}

46
tests/phpunit/tests/blocks/wpBlockPatternsRegistry.php
View File

@ -316,29 +316,6 @@ class Tests_Blocks_wpBlockPattersRegistry extends WP_UnitTestCase {
$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.
*
@ -391,29 +368,6 @@ class Tests_Blocks_wpBlockPattersRegistry extends WP_UnitTestCase {
$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.
*