Pass correct content argument to enter transforms #54108
Merged
Conversation
This file contains 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
jsnajdr
requested review from
fluiddot,
dcalhoun and
ajitbohra
as code owners
jsnajdr
added
[Type] Bug
|
Size Change: +2 B (0%) Total Size: 1.51 MB
ℹ️ View Unchanged
|
Mamaduka
reviewed
Sep 1, 2023
There was a problem hiding this comment.
I agree that this would be a breaking change. The code has been in the core for years now.
Maybe we should update the documentation; note that callback receives an attributes-like object, plus keep the heading transformation fix.
Cc-ing @ellatrix and @ntsekouras as they are more familiar with the code in question.
jsnajdr
requested review from
ryanwelcher,
juanmaguitar,
fabiankaegy and
ndiego
as code owners
Yes, that's true, I found on wpdirectory.net that the TablePress plugin is actively using the current API: 
I reverted the change that modifies the |
mikachan
added
the
[Feature] Block API
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixed a bug that I found when testing the Table of Contents block (namely its refactoring in #54094). Steps to reproduce:
/h2Enter in the slash inserter to create a new Heading block.This happens because the Heading block's
entertransform creates thecore/headingblock with an incorrectcontentattribute. It should be a string, but instead it's an object,{ content: 'foo' }.The fix is to:
transformfunction with acontentargument that is a string, not with anattributesargument that is a{ content: string }object. That's how theentertransform is documented, and also how the similarprefixtransform is documented and implemented.contentparameter when creating thecore/headingblock. The/h2value is not interesting and we don't want it to become the heading's text. Similar transforms forcore/codeandcore/separatoralso ignore thecontentparameter.There might be backward compatibility issues with this fix. If a plugin registers an
entertransform that uses thecontentparameter, and assumes it to be anattributes-like object, it will stop working. Maybe, for compatibility, we should create a special class that acts both as a string and as an object with a.contentattribute:Then both
transform( content ) {}andtransform( { content } ) {}is possible.