Block Hooks: Set ignoredHookedBlocks metada attr upon insertion #58553
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
ockham
added
[Type] Enhancement
|
Size Change: +217 B (0%) Total Size: 1.71 MB
ℹ️ View Unchanged
|
ockham
force-pushed
the
add/ignored-hooked-blocks-metadata-attr-upon-insertion
branch
from
bb8367d
to
5ff53fc
Compare
ockham
commented
Feb 1, 2024
| return { | ||
| ...blockItemBase, | ||
| initialAttributes: {}, | ||
| initialAttributes, |
There was a problem hiding this comment.
I was glad to learn that we already had an initialAttributes arg, as that's exactly what we'd like to set here.
ockham
commented
Feb 1, 2024
packages/blocks/src/api/templates.js
Outdated
Comment on lines
118
to
146
| const hookedBlocksForCurrentBlock = getBlockTypes()?.filter( | ||
| ( { blockHooks } ) => blockHooks && blockName in blockHooks | ||
| ); | ||
|
|
||
| if ( hookedBlocksForCurrentBlock?.length ) { | ||
| const { metadata, ...otherAttributes } = blockAttributes; | ||
| blockAttributes = { | ||
| metadata: { | ||
| ignoredHookedBlocks: hookedBlocksForCurrentBlock.map( | ||
| ( hookedBlock ) => hookedBlock.name | ||
| ), | ||
| ...blockAttributes.metadata, | ||
| }, | ||
| ...otherAttributes, | ||
| }; | ||
| } | ||
|
|
There was a problem hiding this comment.
This is needed for blocks that aren't inserted directly from the inserter, but as inner blocks of a container block. One example would be the Comment Template hook, which is typically inserted as part of the Comments block.
Unfortunately, the initialAttributes concept doesn't exist here 😕
|
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. |
This was referenced Feb 2, 2024
ockham
force-pushed
the
add/ignored-hooked-blocks-metadata-attr-upon-insertion
branch
from
bf92975
to
0d26833
Compare
|
Flaky tests detected in 9d5a9ba. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/7785896196
|
ockham
requested review from
ellatrix,
ajitbohra,
ryanwelcher,
juanmaguitar,
fabiankaegy and
ndiego
as code owners
|
Gotta look into some failing tests... |
ockham
force-pushed
the
add/ignored-hooked-blocks-metadata-attr-upon-insertion
branch
from
e47ef93
to
268a7c8
Compare
gziolo
reviewed
Feb 7, 2024
gziolo
approved these changes
Feb 8, 2024
This reverts commit 6f973f9.
ockham
force-pushed
the
add/ignored-hooked-blocks-metadata-attr-upon-insertion
branch
from
ea6fc04
to
c257a66
Compare
ockham
deleted the
add/ignored-hooked-blocks-metadata-attr-upon-insertion
branch
This was referenced Feb 12, 2024
Block Hooks: Inject hooked blocks into modified templates and parts
WordPress/wordpress-develop#5726
Closed
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.
What?
Set the
metadata.ignoredHookedBlocksattribute upon inserting a new block that has hooked blocks.Why?
To unblock WordPress/wordpress-develop#5726 (see WordPress/wordpress-develop#5712 (comment)).
In WP 6.5, we'll be enabling insertion of hooked blocks into modified templates/parts/patterns. This is implemented by adding a
metadata.ignoredHookedBlocksattribute to the hooked block's anchor block upon editing.As a consequence, upon insertion of an anchor block, this attribute also needs to be added to that newly inserted instance.
A note on UX: It could be argued that ideally, insertion of a new anchor block should cause its hooked blocks to be inserted alongside with it. This could be a future addition but seems to be a bit more complicated to do. Regardless, the
metadata.ignoredHookedBlocksattribute also would need to be set in that case, in order to avoid double insertion -- meaning that adding that attribute is required as a baseline anyway.How?
AFAICT, there are two mechanisms that set attributes for a newly inserted block:
buildBlockTypeItemis used to build items that appear in the inserter; conveniently, it allows setting aninitialAttribute.synchronizeBlocksWithTemplatefrom atemplateset in the container block.Both mechanisms are modified by this PR to set the
metadata.ignoredHookedBlocksattribute.Testing Instructions
metadata.ignoredHookedBlocksattribute set to include the Like Button block:<!-- wp:post-content {"metadata":{"ignoredHookedBlocks":["ockham/like-button"]}} /-->.metadata.ignoredHookedBlocksattribute set to include the Like Button block:<!-- wp:comment-template {"metadata":{"ignoredHookedBlocks":["ockham/like-button"]}} -->Follow-up
Currently, only hooked blocks that were added via
block.jsonwill be taken into account, but not the ones added via a filter. This will be addressed by #58622.We should then also use it the selector to compute
hookedBlocksForCurrentBlockinblock-hooks.js(so it'll also use the new endpoint as its source of truth). (I've tried that out in 6f973f9 but decided to punt for now as it'd add needless complexity for the time being.)