Block Transforms: Add metadata transformation#72462
Merged
Merged
Conversation
t-hamano
added
[Type] Bug
|
Size Change: +171 B (+0.01%) Total Size: 2.27 MB
ℹ️ View Unchanged
|
Contributor
Author
|
Note: I think this PR should be backported to the 6.9 release, as it fixes issues with the hiding blocks feature and Notes feature. |
t-hamano
commented
Oct 18, 2025
| addFilter( | ||
| 'blocks.switchToBlockType.transformedBlock', | ||
| 'core/color/addTransforms', | ||
| 'core/customClassName/addTransforms', |
Contributor
Author
There was a problem hiding this comment.
Nit: I think this was a copy-paste error, so I fixed it.
t-hamano
commented
Oct 18, 2025
Comment on lines
-46
to
-51
| if ( | ||
| hasBlockSupport( newBlockType, 'className' ) && | ||
| attributes.className | ||
| ) { | ||
| transformedAttributes.className = attributes.className; | ||
| } |
Contributor
Author
There was a problem hiding this comment.
We added this in #72196 to preserve custom classnames, but it was redundant because there was already a hook to convert class names.
t-hamano
force-pushed
the
fix/transform-metadata
branch
from
15ddd7e to
f491a8d
Compare
t-hamano
requested review from
ajitbohra,
fabiankaegy and
tellthemachines
as code owners
|
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 If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Flaky tests detected in f5995f7. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/18615566825
|
ntsekouras
reviewed
Oct 20, 2025
| if ( Object.keys( preservedMetadata ).length > 0 ) { | ||
| return { | ||
| ...result, | ||
| attributes: cleanEmptyObject( { |
Contributor
There was a problem hiding this comment.
There is an interesting issue here that you can test by transforming a single paragraph with some metadata to a Heading block.
Rich text attributes are created with Object.defineProperty, which defaults to non-enumerable attributes. This causes the content not to be added here.
Now, the simple solution would be to wrap only the metadata in cleanEmptyObject. I have no idea what the implications would be to update Rich text attributes. Curious though if @ellatrix remembers whether there was a specific reason for this.
Contributor
Author
There was a problem hiding this comment.
Upon further consideration, I realized that the CleanEmptyObject itself is unnecessary here. This is because this return statement is only executed if preservedMetadata is not empty.
Fixed in f7b214e
ntsekouras
reviewed
Oct 20, 2025
ntsekouras
reviewed
Oct 20, 2025
ntsekouras
reviewed
Oct 20, 2025
| */ | ||
| import { addTransforms } from '../metadata'; | ||
|
|
||
| describe( 'metadata', () => { |
Contributor
There was a problem hiding this comment.
Cool to see some tests here. Thanks!
7 tasks
gutenbergplugin
pushed a commit
that referenced
this pull request
Oct 24, 2025
* Block Transforms: Add metadata transformation * Fix e2e tests * Remove unnecessary cleanEmptyObject Co-authored-by: t-hamano <wildworks@git.wordpress.org> Co-authored-by: ntsekouras <ntsekouras@git.wordpress.org>
github-actions
Bot
added
the
Backported to WP Core
|
I just cherry-picked this PR to the wp/6.9 branch to get it included in the next release: 15df30c |
sidharthpandita1
pushed a commit
to sidharthpandita1/gutenberg
that referenced
this pull request
Oct 24, 2025
* Block Transforms: Add metadata transformation * Fix e2e tests * Remove unnecessary cleanEmptyObject Co-authored-by: t-hamano <wildworks@git.wordpress.org> Co-authored-by: ntsekouras <ntsekouras@git.wordpress.org>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What?
This PR uses the
blocks.switchToBlockType.transformedBlockhook to preserve three metadatanoteID,blockVisibility, andnameduring block transformation.Why?
We took the first step in #72196 to try to prevent as many missing attributes as possible when transforming blocks. This resolved the issue for block transformations that use the getTransformedAttributes function, but other transformations may still result in missing attributes.
How?
I realized that there is a
blocks.witchToBlockType.transformedBlockshook, which runs on every block transformation. This hook is used in many places to preserve block attributes. Using it ensures that metadata is preserved during any block conversion. However, please note that metadata will not be inherited if the following conditions are met:This logic is similar to that for custom class names.
Testing Instructions
Here is an example that tests whether attributes are preserved:
Screenshots or screencast
ba954cb2abda37743fdd71e65f8a289b.mp4
Next Plan
I am considering automatically preserving all attributes except for the block bindings API via
blocks.switchToBlockType.transformedBlockand eventually removing thegetTransformedAttributesfunction itself.