mirror_php/wordpress
1
0
Fork 0
mirror of git://develop.git.wordpress.org/ synced 2025-02-25 17:13:30 +01:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity

Templates: Introduce _remove_theme_attribute_from_template_part_block.

Browse Source 
Introduce a `_remove_theme_attribute_from_template_part_block()` function that can be used as a callback argument for `traverse_and_serialize_block(s)` on a parsed block tree in order to remove the `theme` attribute from all Template Part blocks found therein, and deprecate `_remove_theme_attribute_in_block_template_content()`.

Counterpart to `_inject_theme_attribute_in_template_part_block` from #59338 (which superseded `_inject_theme_attribute_in_block_template_content`, deprecated in #59452).

Props mukesh27.
Fixes #59460.

git-svn-id: https://develop.svn.wordpress.org/trunk@56724 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Bernie Reiter 2023-09-26 16:59:11 +00:00
parent 0ed8dcda72
commit 76c6b57867
3 changed files with 80 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -490,36 +490,21 @@ function _inject_theme_attribute_in_template_part_block( &$block ) {
}
/**
* Parses a block template and removes the theme attribute from each template part.
* Removes the `theme` attribute from a given template part block.
*
* @since 5.9.0
* @since 6.4.0
* @access private
*
* @param string $template_content Serialized block template content.
* @return string Updated block template content.
* @param array $block a parsed block.
* @return void
*/
function _remove_theme_attribute_in_block_template_content( $template_content ) {
$has_updated_content = false;
$new_content = '';
$template_blocks = parse_blocks( $template_content );
$blocks = _flatten_blocks( $template_blocks );
foreach ( $blocks as $key => $block ) {
if ( 'core/template-part' === $block['blockName'] && isset( $block['attrs']['theme'] ) ) {
unset( $blocks[ $key ]['attrs']['theme'] );
$has_updated_content = true;
}
function _remove_theme_attribute_from_template_part_block( &$block ) {
if (
'core/template-part' === $block['blockName'] &&
isset( $block['attrs']['theme'] )
) {
unset( $block['attrs']['theme'] );
}
if ( ! $has_updated_content ) {
return $template_content;
}
foreach ( $template_blocks as $block ) {
$new_content .= serialize_block( $block );
}
return $new_content;
}
/**
@ -1278,7 +1263,10 @@ function wp_generate_block_templates_export_file() {
// Load templates into the zip file.
$templates = get_block_templates();
foreach ( $templates as $template ) {
$template->content = _remove_theme_attribute_in_block_template_content( $template->content );
$template->content = traverse_and_serialize_blocks(
parse_blocks( $template->content ),
'_remove_theme_attribute_from_template_part_block'
);
$zip->addFromString(
'templates/' . $template->slug . '.html',

40
src/wp-includes/deprecated.php
View File

@ -6084,3 +6084,43 @@ function _inject_theme_attribute_in_block_template_content( $template_content )
return $template_content;
}
/**
* Parses a block template and removes the theme attribute from each template part.
*
* @since 5.9.0
* @deprecated 6.4.0 Use traverse_and_serialize_blocks( parse_blocks( $template_content ), '_remove_theme_attribute_from_template_part_block' ) instead.
* @access private
*
* @param string $template_content Serialized block template content.
* @return string Updated block template content.
*/
function _remove_theme_attribute_in_block_template_content( $template_content ) {
_deprecated_function(
__FUNCTION__,
'6.4.0',
'traverse_and_serialize_blocks( parse_blocks( $template_content ), "_remove_theme_attribute_from_template_part_block" )'
);
$has_updated_content = false;
$new_content = '';
$template_blocks = parse_blocks( $template_content );
$blocks = _flatten_blocks( $template_blocks );
foreach ( $blocks as $key => $block ) {
if ( 'core/template-part' === $block['blockName'] && isset( $block['attrs']['theme'] ) ) {
unset( $blocks[ $key ]['attrs']['theme'] );
$has_updated_content = true;
}
}
if ( ! $has_updated_content ) {
return $template_content;
}
foreach ( $template_blocks as $block ) {
$new_content .= serialize_block( $block );
}
return $new_content;
}

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

@ -361,13 +361,39 @@ class Tests_Block_Template_Utils extends WP_UnitTestCase {
/**
* @ticket 54448
* @ticket 59460
*
* @dataProvider data_remove_theme_attribute_in_block_template_content
*
* @expectedDeprecated _remove_theme_attribute_in_block_template_content
*/
public function test_remove_theme_attribute_in_block_template_content( $template_content, $expected ) {
$this->assertSame( $expected, _remove_theme_attribute_in_block_template_content( $template_content ) );
}
/**
* @ticket 59460
*
* @covers ::_remove_theme_attribute_from_template_part_block
* @covers ::traverse_and_serialize_blocks
*
* @dataProvider data_remove_theme_attribute_in_block_template_content
*
* @param string $template_content The template markup.
* @param string $expected The expected markup after removing the theme attribute from Template Part blocks.
*/
public function test_remove_theme_attribute_from_template_part_block( $template_content, $expected ) {
$template_content_parsed_blocks = parse_blocks( $template_content );
$this->assertSame(
$expected,
traverse_and_serialize_blocks(
$template_content_parsed_blocks,
'_remove_theme_attribute_from_template_part_block'
)
);
}
public function data_remove_theme_attribute_in_block_template_content() {
return array(
array(