Skip to content

Block Hooks: Set ignoredHookedBlocks metadata upon saving #6087

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
ockham wants to merge 29 commits into from
Closed

Block Hooks: Set ignoredHookedBlocks metadata upon saving #6087

Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
b5aaa44
Don't set ignoredHookedBlocks metadata upon read
ockham Feb 12, 2024
2e28810
Don't pass anchor_block by reference
ockham Feb 12, 2024
40fa3fb
Update PHPDoc
ockham Feb 12, 2024
1f0d087
Add new set_ignored_hooked_blocks_metadata() function
ockham Feb 12, 2024
c434d75
Whitespace
ockham Feb 12, 2024
b63d367
Fix first batch of unit tests
ockham Feb 12, 2024
36c0fc3
Fix remaining unit tests
ockham Feb 12, 2024
2358241
There can never be enough callbacks
ockham Feb 12, 2024
0330473
Tweak set_ignored_hooked_blocks_metadata to match callback signature
ockham Feb 12, 2024
e6eea6e
Wire it all up
ockham Feb 12, 2024
eb1daa1
Whitespace
ockham Feb 13, 2024
d057ece
Bail early
ockham Feb 13, 2024
ab6a8c9
Actually update post
ockham Feb 13, 2024
998147f
Use correct action
ockham Feb 13, 2024
1296344
Add action for template parts
ockham Feb 13, 2024
27724fc
Add note on action vs filter
ockham Feb 13, 2024
012004b
Clarify comment
ockham Feb 13, 2024
27a2ec8
Fix more unit tests
ockham Feb 13, 2024
12ccd0d
Start adding test coverage for set_ignored_hooked_blocks_metadata
ockham Feb 13, 2024
1128b5f
Add more test coverage and a small fix
ockham Feb 13, 2024
5817b49
Add test coverage for hooked block added by filter
ockham Feb 13, 2024
60b2732
Add test to cover context-aware filter
ockham Feb 13, 2024
61847cb
Remove obsolete comment about post_filtered_content
ockham Feb 13, 2024
712260f
Move set_ignored_hooked_blocks_metadata function definition below ins…
ockham Feb 13, 2024
7c7f01e
Inline get_hooked_block_markup
ockham Feb 13, 2024
f4f856b
Coding Standards in test
ockham Feb 13, 2024
7d43f21
Add test coverage to verify hooked blocks aren't added if ignored
ockham Feb 13, 2024
3c9aa4b
Move set_ignored_hooked_blocks_metadata_upon_rest_insert to block-tem…
ockham Feb 13, 2024
51832fe
Rename to inject_ignored_hooked_blocks_metadata_attributes
ockham Feb 13, 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
Prev Previous commit
Next Next commit
Whitespace
  • Loading branch information
@ockham
ockham committed Feb 13, 2024
commit eb1daa1ecd1ec6c4a13bb358e901a7c6e578ce09
2 changes: 1 addition & 1 deletion src/wp-includes/blocks.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -873,7 +873,7 @@ function set_ignored_hooked_blocks_metadata( &$parsed_anchor_block, $relative_po

/** This filter is documented in wp-includes/blocks.php */
$hooked_block_types = apply_filters( 'hooked_block_types', $hooked_block_types, $relative_position, $anchor_block_type, $context );
if ( empty ( $hooked_block_types ) ) {
if ( empty( $hooked_block_types ) ) {
return '';
Copy link

@tjcafferkey tjcafferkey Feb 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know what the convention is but do we have to explicitly return a value? E.g. can we not just return;?

Copy link
Contributor Author

@ockham ockham Feb 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The function that this is part of -- set_ignored_hooked_blocks_metadata -- is used as a callback arg for make_{before|after}_block_visitor. Its signature needs to be consistent with insert_hooked_blocks, which is the default value for the callback.

Previously, when insert_hooked_blocks would take care of both inserting hooked blocks and setting the anchor block's metadata.ignoredHookedBlocks attribute, it needed a way to do both. I decided to pass the anchor block as a reference, and to have insert_hooked_blocks return the markup generated for the inserted hooked blocks as a string.

It's still doing the latter; and make_{before|after}_block_visitor expects a string as a return value, which it'll happily prepend or append to the current block, respectively.

I could maybe change the visitors to allow for null or falsey return values, causing the visitor to ignore the return value 🤔 It's just that an empty string was kinda easier to do 😅

Copy link

@tjcafferkey tjcafferkey Feb 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I see. I think leaving it as is, is fine. My question came from a place of curiosity which this answers. Thank you!

}

Expand Down