Skip to content

Add layout classes to legacy Group inner container #5812

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
tellthemachines wants to merge 8 commits into from
Closed

Add layout classes to legacy Group inner container #5812

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a6612eb
Add layout classes to legacy Group inner container
tellthemachines Dec 22, 2023
6967291
Update src/wp-includes/block-supports/layout.php
tellthemachines Jan 3, 2024
9cee08e
Update src/wp-includes/block-supports/layout.php
tellthemachines Jan 3, 2024
2829f71
Update src/wp-includes/block-supports/layout.php
tellthemachines Jan 3, 2024
e322084
Update tests/phpunit/tests/block-supports/layout.php
tellthemachines Jan 3, 2024
c2ee522
Remove white space
tellthemachines Jan 3, 2024
a62d628
Remove condition and change array syntax.
tellthemachines Jan 3, 2024
1bfb628
Change auto generated class to use `is-layout` pattern
tellthemachines Jan 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 32 additions & 4 deletions src/wp-includes/block-supports/layout.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -638,7 +638,7 @@ function wp_render_layout_support_flag( $block_content, $block ) {
* for features like the enhanced pagination of the Query block.
*/
$container_class = wp_unique_prefixed_id(
'wp-container-' . sanitize_title( $block['blockName'] ) . '-layout-'
'wp-container-' . sanitize_title( $block['blockName'] ) . '-is-layout-'
);

// Set the correct layout type for blocks using legacy content width.
Expand Down Expand Up @@ -883,17 +883,45 @@ function wp_restore_group_inner_container( $block_content, $block ) {
return $block_content;
}

$replace_regex = sprintf(
/*
* This filter runs after the layout classnames have been added to the block, so they
* have to be removed from the outer wrapper and then added to the inner.
*/
$layout_classes = array();
$processor = new WP_HTML_Tag_Processor( $block_content );

if ( $processor->next_tag( array( 'class_name' => 'wp-block-group' ) ) ) {
foreach ( $processor->class_list() as $class_name ) {
if ( str_contains( $class_name, 'is-layout-' ) ) {
$layout_classes[] = $class_name;
$processor->remove_class( $class_name );
}
}
}

$content_without_layout_classes = $processor->get_updated_html();
$replace_regex = sprintf(
'/(^\s*<%1$s\b[^>]*wp-block-group[^>]*>)(.*)(<\/%1$s>\s*$)/ms',
preg_quote( $tag_name, '/' )
);
$updated_content = preg_replace_callback(
$updated_content = preg_replace_callback(
$replace_regex,
static function ( $matches ) {
return $matches[1] . '<div class="wp-block-group__inner-container">' . $matches[2] . '</div>' . $matches[3];
},
$block_content
$content_without_layout_classes
);

// Add layout classes to inner wrapper.
if ( ! empty( $layout_classes ) ) {
$processor = new WP_HTML_Tag_Processor( $updated_content );
if ( $processor->next_tag( array( 'class_name' => 'wp-block-group__inner-container' ) ) ) {
foreach ( $layout_classes as $class_name ) {
$processor->add_class( $class_name );
}
}
$updated_content = $processor->get_updated_html();
}
return $updated_content;
}

Expand Down
90 changes: 90 additions & 0 deletions tests/phpunit/tests/block-supports/layout.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,4 +252,94 @@ public function data_layout_support_flag_renders_classnames_on_wrapper() {
),
);
}

/**
* Check that wp_restore_group_inner_container() restores the legacy inner container on the Group block.
*
* @ticket 60130
*
* @covers ::wp_restore_group_inner_container
*
* @dataProvider data_restore_group_inner_container
*
* @param array $args Dataset to test.
* @param string $expected_output The expected output.
*/
public function test_restore_group_inner_container( $args, $expected_output ) {
$actual_output = wp_restore_group_inner_container( $args['block_content'], $args['block'] );
$this->assertEquals( $expected_output, $actual_output );
}

/**
* Data provider for test_restore_group_inner_container.
*
* @return array
*/
public function data_restore_group_inner_container() {
return array(
'group block with existing inner container' => array(
'args' => array(
'block_content' => '<div class="wp-block-group"><div class="wp-block-group__inner-container"></div></div>',
'block' => array(
'blockName' => 'core/group',
'attrs' => array(
'layout' => array(
'type' => 'default',
),
),
'innerBlocks' => array(),
'innerHTML' => '<div class="wp-block-group"><div class="wp-block-group__inner-container"></div></div>',
'innerContent' => array(
'<div class="wp-block-group"><div class="wp-block-group__inner-container">',
' ',
' </div></div>',
),
),
),
'expected_output' => '<div class="wp-block-group"><div class="wp-block-group__inner-container"></div></div>',
),
'group block with no existing inner container' => array(
'args' => array(
'block_content' => '<div class="wp-block-group"></div>',
'block' => array(
'blockName' => 'core/group',
'attrs' => array(
'layout' => array(
'type' => 'default',
),
),
'innerBlocks' => array(),
'innerHTML' => '<div class="wp-block-group"></div>',
'innerContent' => array(
'<div class="wp-block-group">',
' ',
' </div>',
),
),
),
'expected_output' => '<div class="wp-block-group"><div class="wp-block-group__inner-container"></div></div>',
),
'group block with layout classnames' => array(
'args' => array(
'block_content' => '<div class="wp-block-group is-layout-constrained wp-block-group-is-layout-constrained"></div>',
'block' => array(
'blockName' => 'core/group',
'attrs' => array(
'layout' => array(
'type' => 'default',
),
),
'innerBlocks' => array(),
'innerHTML' => '<div class="wp-block-group"></div>',
'innerContent' => array(
'<div class="wp-block-group">',
' ',
' </div>',
),
),
),
'expected_output' => '<div class="wp-block-group"><div class="wp-block-group__inner-container is-layout-constrained wp-block-group-is-layout-constrained"></div></div>',
),
);
}
}