Blocks: Introduce filter to allow easy addition of hooked blocks #5271

ockham · 2023-09-21T16:57:08Z

Introduce a hooked_block_types filter that allows even easier conditional addition (or removal) of hooked blocks for a given anchor block and relative position.

function insert_shopping_cart_hooked_block( $hooked_blocks, $position, $anchor_block, $context ) {
	if ( 'after' === $position && 'core/navigation' === $anchor_block && /** $context is header template part **/ ) {
		$hooked_blocks[] = 'mycommerce/shopping-cart';
	}
	return $hooked_blocks;
}
add_filter( 'hooked_block_types', 'insert_shopping_cart_hooked_block', 10, 4 );

Based on an idea by @gziolo that we discussed during a call earlier today.

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

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.

ockham · 2023-09-21T16:58:00Z

src/wp-includes/blocks.php

+			/**
+			 * Filters the serialized markup of a hooked block.
+			 *
+			 * @since 6.4.0
+			 *
+			 * @param string                  $hooked_block_markup The serialized markup of the hooked block.
+			 * @param string                  $hooked_block_type   The type of the hooked block.
+			 * @param string                  $relative_position   The relative position of the hooked block.
+			 *                                                     Can be one of 'before', 'after', 'first_child', or 'last_child'.
+			 * @param array                   $block               The anchor block.
+			 * @param WP_Block_Template|array $context             The block template, template part, or pattern that the anchor block belongs to.
+			 */
+			$markup .= apply_filters( 'inject_hooked_block_markup', $hooked_block_markup, $hooked_block_type, $relative_position, $block, $context );


@gziolo We might consider removing the inject_hooked_block_markup filter in a follow-up; it might be a bit low-level (and less useful?) after all.

I need to think a bit more about it, but at first glance, it looks like they are mostly the same.

inject_hooked_block_markup operates on the markup level, so it basically allows setting any string as the return value. The difference in the params available in the filter is that hooked_block_types uses the block name as the anchor, in contrast to the block type object that inject_hooked_block_markup offers for the parent or sibling block. I would be in favor of keeping only hooked_block_types which is a nice abstraction as it's just a list of block names.

Sounds good. We can either land this PR and remove inject_hooked_block_markup in a follow-up, or do it as part of this PR.

ockham · 2023-09-21T16:58:27Z

FYI @nerrad @ndiego

ockham · 2023-09-21T17:02:57Z

src/wp-includes/blocks.php

+			 * @param string                  $anchor_block_type   The anchor block type.
+			 * @param WP_Block_Template|array $context             The block template, template part, or pattern that the anchor block belongs to.
+			 */
+			$hooked_block_types = apply_filters( 'hooked_block_types', $hooked_block_types, $relative_position, $anchor_block_type, $context );


Should we call the filter just hooked_blocks?

I like hooked_block_types personally, but defer to you all. It makes it clear to me that you are filtering the "block types" and not the entire block markup or something else.

Agree with Nick here although it does make me wonder how consistent the codebase is in differentiating between "blocks" and "block types".

how consistent the codebase is in differentiating between "blocks" and "block types".

😬 I support any effort to draw those distinctions where they haven't already been blurred.

hooked_block_types sounds good 👍🏻

nerrad · 2023-09-21T17:30:29Z

src/wp-includes/blocks.php

-				 */
-				$markup .= apply_filters( 'inject_hooked_block_markup', $hooked_block_markup, $hooked_block_type, $relative_position, $block, $context );
-			}
+		$relative_position  = 'before';


Minor, but I wonder if the various $relative_position values should be constants (something like WP_Block_Hooks::RELATIVE_POSITION_BEFORE, WP_Block_Hooks::RELATIVE_POSITION_FIRST_CHILD ...etc). This could reduce some variable declaration and make it more straightforward/clear for extension use.

Ah yeah, good point. I think it hadn't occurred to me since we need to use the position values verbatim in block.json -- but it might make sense to add constants in the code 👍

did we update the block.json schema so that these values can be drawn from an auto-completed list with inline documentation?

This is what we have in the schema:

https://github.com/WordPress/gutenberg/blob/aa938166f28bcfff6c7b8d1caac5a95f78852f97/schemas/json/block.json#L686-L695

Speaking of schema, I opened #5278 to align the schemas between Gutenberg and WordPress core.

gziolo

Excellent idea with the new better scoped filters hooked_block_types. I would be in favor of removing inject_hooked_block_markup filters as they are low-level and offer too much power in contrast to the new proposal. We can always add them back later if it turns out they are essential for more advanced usage that I can't think of at the moment.

ockham · 2023-09-25T08:28:12Z

Excellent idea with the new better scoped filters hooked_block_types. I would be in favor of removing inject_hooked_block_markup filters as they are low-level and offer too much power in contrast to the new proposal. We can always add them back later if it turns out they are essential for more advanced usage that I can't think of at the moment.

Great, thank you! I agree 100% -- YAGNI and all 😉
I'll land this change, and will then do a follow-up to remove inject_hooked_block_markup.

Introduce a `hooked_block_types` filter that allows easier conditional addition (or removal) of hooked blocks for a given anchor block and relative position. {{{#!php function insert_shopping_cart_hooked_block( $hooked_blocks, $position, $anchor_block, $context ) { if ( 'after' === $position && 'core/navigation' === $anchor_block && /** $context is header template part **/ ) { $hooked_blocks[] = 'mycommerce/shopping-cart'; } return $hooked_blocks; } add_filter( 'hooked_block_types', 'insert_shopping_cart_hooked_block', 10, 4 ); }}} Props gziolo, nerrad, dmsnell, ndiego. Fixes #59424.

ockham · 2023-09-25T08:43:21Z

Committed to Core in https://core.trac.wordpress.org/changeset/56673.

ockham self-assigned this Sep 21, 2023

ockham commented Sep 21, 2023

View reviewed changes

ockham requested a review from gziolo September 21, 2023 16:58

ockham commented Sep 21, 2023

View reviewed changes

nerrad reviewed Sep 21, 2023

View reviewed changes

ockham mentioned this pull request Sep 25, 2023

Include Block Hooks in WordPress 6.4 WordPress/gutenberg#53987

Closed

19 tasks

gziolo approved these changes Sep 25, 2023

View reviewed changes

ockham force-pushed the add/hooked-block-filter branch from ac7f792 to 373d176 Compare September 25, 2023 08:41

ockham closed this Sep 25, 2023

ockham deleted the add/hooked-block-filter branch September 25, 2023 08:43

This was referenced Sep 25, 2023

Blocks: Remove inject_hooked_block_markup filter #5292

Closed

Epic: Block Hooks Features for WP 6.5 WordPress/gutenberg#54904

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Blocks: Introduce filter to allow easy addition of hooked blocks #5271

Blocks: Introduce filter to allow easy addition of hooked blocks #5271

ockham commented Sep 21, 2023 •

edited

Loading

ockham Sep 21, 2023

gziolo Sep 21, 2023

gziolo Sep 22, 2023

ockham Sep 22, 2023

ockham commented Sep 21, 2023

ockham Sep 21, 2023

ndiego Sep 21, 2023

nerrad Sep 21, 2023

dmsnell Sep 21, 2023

gziolo Sep 22, 2023

nerrad Sep 21, 2023

ockham Sep 21, 2023

dmsnell Sep 21, 2023

gziolo Sep 22, 2023

gziolo Sep 25, 2023

gziolo left a comment

ockham commented Sep 25, 2023

ockham commented Sep 25, 2023

Blocks: Introduce filter to allow easy addition of hooked blocks #5271

Blocks: Introduce filter to allow easy addition of hooked blocks #5271

Conversation

ockham commented Sep 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ockham commented Sep 21, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gziolo left a comment

Choose a reason for hiding this comment

ockham commented Sep 25, 2023

ockham commented Sep 25, 2023

ockham commented Sep 21, 2023 •

edited

Loading