Patterns: Add the pattern name to pattern blocks when they are converted #10248

ramonjd · 2025-10-14T06:09:40Z

Builds upon #10180

Modifies the resolve_pattern_blocks function to include metadata for single-root patterns, allowing the pattern name and title to be stored in the block attributes. The metadata contains the patternName and name attributes.

This enables identification of patterns inside templates and allows for special treatment in the editor.

This will be used to test contentOnly editing (WordPress/gutenberg#71517), so that themes that use patterns automatically opt into this behaviour.

Trac ticket: https://core.trac.wordpress.org/ticket/64123

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

github-actions · 2025-10-14T06:09:52Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props ramonopoly, andrewserong, talldanwp, westonruter, scruffian.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

github-actions · 2025-10-14T06:24:41Z

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

The Plugin and Theme Directories cannot be accessed within Playground.
All changes will be lost when closing a tab with a Playground instance.
All changes will be lost when refreshing the page.
A fresh instance is created each time the link below is clicked.
Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

src/wp-includes/blocks.php

scruffian · 2025-10-22T13:20:32Z

Is there other metadata we could/should add to patterns - some of them seem to also contain a longer description. It would be good to support as much metadata as possible IMO.

ramonjd · 2025-10-22T22:19:57Z

Is there other metadata we could/should add to patterns - some of them seem to also contain a longer description. It would be good to support as much metadata as possible IMO.

Good question. What do you think the editor might need? There are also optional categories and block types, which could come in handy if the editor ever wanted to extend "change design" to patterns bundled with templates.

I'm not sure.

scruffian · 2025-10-23T05:53:40Z

The description would be useful for WordPress/gutenberg#72574. Not sure about the others.

ramonjd · 2025-10-24T01:46:29Z

The description would be useful for WordPress/gutenberg#72574.

Done!

src/wp-includes/blocks.php

talldan · 2025-11-20T07:11:29Z

src/wp-includes/blocks.php

+			$blocks_to_insert = parse_blocks( trim( $pattern['content'] ) );
+
+			$blocks_to_insert = parse_blocks( trim( $pattern['content'] ) );


Should these lines be duplicated like this?

WUT? No they shouldn't 😄

Thanks for spotting that. Human paste error.

ramonjd · 2025-11-20T23:21:47Z

src/wp-includes/blocks.php

+			$blocks_to_insert = parse_blocks( trim( $pattern['content'] ) );
+
+			$blocks_to_insert = parse_blocks( trim( $pattern['content'] ) );


Suggested change

$blocks_to_insert = parse_blocks( trim( $pattern['content'] ) );

$blocks_to_insert = parse_blocks( trim( $pattern['content'] ) );

$blocks_to_insert = parse_blocks( trim( $pattern['content'] ) );

westonruter · 2025-11-26T04:08:09Z

src/wp-includes/blocks.php

+			* For single-root patterns, add the pattern name to make this a pattern instance in the editor.
+			* If the pattern has metadata, merge it with the existing metadata.
+			*/


Suggested change

* For single-root patterns, add the pattern name to make this a pattern instance in the editor.

* If the pattern has metadata, merge it with the existing metadata.

*/

* For single-root patterns, add the pattern name to make this a pattern instance in the editor.

* If the pattern has metadata, merge it with the existing metadata.

*/

westonruter · 2025-11-26T04:08:29Z

src/wp-includes/blocks.php

+				* Merge pattern metadata with existing block metadata.
+				* Pattern metadata takes precedence, but existing block metadata
+				* is preserved as a fallback when the pattern doesn't define that field.
+				* Only the defined fields (name, description, categories) are updated;
+				* other metadata keys are preserved.
+				*/


Suggested change

* Merge pattern metadata with existing block metadata.

* Pattern metadata takes precedence, but existing block metadata

* is preserved as a fallback when the pattern doesn't define that field.

* Only the defined fields (name, description, categories) are updated;

* other metadata keys are preserved.

*/

* Merge pattern metadata with existing block metadata.

* Pattern metadata takes precedence, but existing block metadata

* is preserved as a fallback when the pattern doesn't define that field.

* Only the defined fields (name, description, categories) are updated;

* other metadata keys are preserved.

*/

westonruter · 2025-11-26T04:11:13Z

src/wp-includes/blocks.php

+				) as $key => $pattern_key ) {
+					$value = $pattern[ $pattern_key ] ?? $block_metadata[ $key ] ?? null;
+					if ( $value ) {
+						$block_metadata[ $key ] = 'categories' === $key && is_array( $value )


Is the $key check needed here? Shouldn't array_map() always be used when the value is an array, regardless of the key?

Suggested change

$block_metadata[ $key ] = 'categories' === $key && is_array( $value )

$block_metadata[ $key ] = is_array( $value )

By jove, you're right! I just commit stuff when it works

…r single-root patterns, allowing the pattern name and title to be stored in the block attributes. Adds unit tests.

…cks` function Enhances the `resolve_pattern_blocks` function to include additional metadata attributes such as `description` and `categories` for single-root patterns. Updates unit tests to validate the new functionality, including sanitization of potentially harmful characters in pattern attributes.

Refines the logic for merging metadata in single-root patterns, ensuring that existing metadata is preserved and new attributes such as `name`, `description`, and `categories` are correctly integrated. Updates unit tests to validate the new behavior, including a test for preserving existing metadata.

…teardown in `resolvePatternBlocks` test suite.

Improves the handling of metadata for single-root patterns by ensuring that existing metadata is preserved while integrating new attributes such as `name`, `description`, and `categories`. Updates unit tests to reflect the changes in metadata structure, ensuring accurate representation of merged metadata.

…n single-pattern container blocks for version 7.0.0.

Introduces a new block pattern 'core/with-custom-metadata' with custom metadata keys. Updates the unit tests to ensure that custom metadata is preserved when resolving patterns, enhancing the test coverage for metadata handling in block patterns.

Improves the documentation within the `resolve_pattern_blocks` function by enhancing comments related to metadata handling for single-root patterns. This change aims to provide clearer guidance on the merging process of pattern metadata with existing block metadata.

Co-authored-by: ramonjd <[email protected]>

Co-authored-by: ramonjd <[email protected]> Source: WordPress/gutenberg@ec6ec9e

ramonjd mentioned this pull request Oct 14, 2025

Add the pattern name to pattern blocks when they are converted #10180

Closed

ramonjd commented Oct 15, 2025

View reviewed changes

src/wp-includes/blocks.php Outdated Show resolved Hide resolved

ramonjd force-pushed the try/add-metadata-to-parsed-pattern-root-block-attributes branch 3 times, most recently from b5812e5 to d8f1d20 Compare October 21, 2025 01:01

ramonjd changed the title ~~Add the pattern name to pattern blocks when they are converted [unit tests]~~ Patterns: Add the pattern name to pattern blocks when they are converted Oct 21, 2025

ramonjd self-assigned this Oct 21, 2025

ramonjd added the enhancement label Oct 21, 2025

ramonjd requested review from scruffian and talldan October 22, 2025 22:20

ramonjd force-pushed the try/add-metadata-to-parsed-pattern-root-block-attributes branch from d8f1d20 to ed8d449 Compare October 24, 2025 01:45

ramonjd mentioned this pull request Oct 29, 2025

contentOnly patterns: mark patterns as contentOnly by adding metadata.patternName to the root block WordPress/gutenberg#71888

Closed

ramonjd force-pushed the try/add-metadata-to-parsed-pattern-root-block-attributes branch from ed8d449 to dc0bc0a Compare November 5, 2025 01:43

ramonjd added a commit to WordPress/gutenberg that referenced this pull request Nov 5, 2025

Starting to backport WordPress/wordpress-develop#10248 to GB

face42f

ramonjd mentioned this pull request Nov 5, 2025

contentOnly patterns: mark patterns as contentOnly by adding metadata.patternName to the root block WordPress/gutenberg#72988

Merged

1 task

andrewserong reviewed Nov 5, 2025

View reviewed changes

src/wp-includes/blocks.php Outdated Show resolved Hide resolved

ramonjd force-pushed the try/add-metadata-to-parsed-pattern-root-block-attributes branch 2 times, most recently from ef3a7bc to a640eaa Compare November 10, 2025 05:13

ramonjd mentioned this pull request Nov 18, 2025

contentOnly patterns: mark patterns with multiple root blocks as patterns WordPress/gutenberg#73262

Open

talldan reviewed Nov 20, 2025

View reviewed changes

ramonjd commented Nov 20, 2025

View reviewed changes

westonruter reviewed Nov 26, 2025

View reviewed changes

ramonjd added 2 commits November 26, 2025 15:43

Modifies the resolve_pattern_blocks function to include metadata fo…

be401b0

…r single-root patterns, allowing the pattern name and title to be stored in the block attributes. Adds unit tests.

ramonjd added 7 commits November 26, 2025 15:43

LINTO

8cf12ad

Remove the block pattern 'core/existing-metadata' from the unit test …

fbcce00

…teardown in `resolvePatternBlocks` test suite.

Update block metadata versioning in blocks.php to reflect changes i…

d4cf16a

…n single-pattern container blocks for version 7.0.0.

ramonjd force-pushed the try/add-metadata-to-parsed-pattern-root-block-attributes branch from a640eaa to 44c4c8f Compare November 26, 2025 04:46

ramonjd added a commit to WordPress/gutenberg that referenced this pull request Nov 26, 2025

Sync with feedback from WordPress/wordpress-develop#10248

3249c20

ramonjd mentioned this pull request Nov 26, 2025

Patterns: resolve_pattern_blocks sync with Core patch WordPress/gutenberg#73570

Merged

ramonjd added a commit to WordPress/gutenberg that referenced this pull request Nov 26, 2025

Sync with feedback from WordPress/wordpress-develop#10248 (#73570)

ec6ec9e

Co-authored-by: ramonjd <[email protected]>

peterwilsoncc pushed a commit to peterwilsoncc/gutenberg-build that referenced this pull request Nov 26, 2025

Sync with feedback from WordPress/wordpress-develop#10248 (#73570)

1d22ebf

Co-authored-by: ramonjd <[email protected]> Source: WordPress/gutenberg@ec6ec9e

		$blocks_to_insert = parse_blocks( trim( $pattern['content'] ) );

		$blocks_to_insert = parse_blocks( trim( $pattern['content'] ) );

	$block_metadata[ $key ] = 'categories' === $key && is_array( $value )
	$block_metadata[ $key ] = is_array( $value )

Patterns: Add the pattern name to pattern blocks when they are converted #10248

Are you sure you want to change the base?

Patterns: Add the pattern name to pattern blocks when they are converted #10248

Uh oh!

Conversation

ramonjd commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 14, 2025

Test using WordPress Playground

Some things to be aware of

Uh oh!

Uh oh!

scruffian commented Oct 22, 2025

Uh oh!

ramonjd commented Oct 22, 2025

Uh oh!

scruffian commented Oct 23, 2025

Uh oh!

ramonjd commented Oct 24, 2025

Uh oh!

Uh oh!

talldan Nov 20, 2025

Choose a reason for hiding this comment

Uh oh!

ramonjd Nov 20, 2025

Choose a reason for hiding this comment

Uh oh!

ramonjd Nov 20, 2025

Choose a reason for hiding this comment

Uh oh!

westonruter Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

westonruter Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

westonruter Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

ramonjd Nov 26, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ramonjd commented Oct 14, 2025 •

edited

Loading

github-actions bot commented Oct 14, 2025 •

edited

Loading