Block Bindings: Backport block bindings refactor from WordPress core #58683
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -47,29 +47,29 @@ function gutenberg_register_metadata_attribute( $args ) { | |
| add_filter( 'register_block_type_args', 'gutenberg_register_metadata_attribute' ); | ||
|
|
||
| /** | ||
| * Depending on the block attribute name, replace its value in the HTML based on the value provided. | ||
| * | ||
| * @param string $block_content Block Content. | ||
| * @param string $block_name The name of the block to process. | ||
| * @param string $attribute_name The attribute name to replace. | ||
| * @param mixed $source_value The value used to replace in the HTML. | ||
| * @return string The modified block content. | ||
| */ | ||
| function gutenberg_block_bindings_replace_html( $block_content, $block_name, string $attribute_name, $source_value ) { | ||
| $block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block_name ); | ||
| if ( ! isset( $block_type->attributes[ $attribute_name ] ) ) { | ||
| return $block_content; | ||
| } | ||
|
|
||
| // Depending on the attribute source, the processing will be different. | ||
| switch ( $block_type->attributes[ $attribute_name ]['source'] ) { | ||
| case 'html': | ||
| case 'rich-text': | ||
| $block_reader = new WP_HTML_Tag_Processor( $block_content ); | ||
|
|
||
| // TODO: Support for CSS selectors whenever they are ready in the HTML API. | ||
| // In the meantime, support comma-separated selectors by exploding them into an array. | ||
| $selectors = explode( ',', $block_type->attributes[ $attribute_name ]['selector'] ); | ||
| // Add a bookmark to the first tag to be able to iterate over the selectors. | ||
| $block_reader->next_tag(); | ||
| $block_reader->set_bookmark( 'iterate-selectors' ); | ||
|
|
@@ -133,12 +133,12 @@ function gutenberg_block_bindings_replace_html( $block_content, $block_name, $bl | |
| if ( ! $amended_content->next_tag( | ||
| array( | ||
| // TODO: build the query from CSS selector. | ||
| 'tag_name' => $block_type->attributes[ $attribute_name ]['selector'], | ||
| ) | ||
| ) ) { | ||
| return $block_content; | ||
| } | ||
| $amended_content->set_attribute( $block_type->attributes[ $attribute_name ]['attribute'], esc_attr( $source_value ) ); | ||
| return $amended_content->get_updated_html(); | ||
| break; | ||
|
|
||
|
|
@@ -153,10 +153,10 @@ function gutenberg_block_bindings_replace_html( $block_content, $block_name, $bl | |
| * Process the block bindings attribute. | ||
| * | ||
| * @param string $block_content Block Content. | ||
| * @param array $parsed_block The full block, including name and attributes. | ||
| * @param WP_Block $block_instance The block instance. | ||
| */ | ||
| function gutenberg_process_block_bindings( $block_content, $parsed_block, $block_instance ) { | ||
| // Allowed blocks that support block bindings. | ||
| // TODO: Look for a mechanism to opt-in for this. Maybe adding a property to block attributes? | ||
| $allowed_blocks = array( | ||
|
|
@@ -167,7 +167,11 @@ function gutenberg_process_block_bindings( $block_content, $block, $block_instan | |
| ); | ||
|
|
||
| // If the block doesn't have the bindings property or isn't one of the allowed block types, return. | ||
| if ( | ||
| ! isset( $allowed_blocks[ $block_instance->name ] ) || | ||
| empty( $parsed_block['attrs']['metadata']['bindings'] ) || | ||
|
Contributor
There was a problem hiding this comment. Here
Contributor
Author
|
||
| ! is_array( $parsed_block['attrs']['metadata']['bindings'] ) | ||
| ) { | ||
| return $block_content; | ||
| } | ||
|
|
||
|
|
@@ -186,34 +190,32 @@ function gutenberg_process_block_bindings( $block_content, $block, $block_instan | |
| * } | ||
| */ | ||
|
|
||
| $modified_block_content = $block_content; | ||
| foreach ( $parsed_block['attrs']['metadata']['bindings'] as $attribute_name => $block_binding ) { | ||
| // If the attribute is not in the allowed list, process next attribute. | ||
| if ( ! in_array( $attribute_name, $allowed_blocks[ $block_instance->name ], true ) ) { | ||
| continue; | ||
| } | ||
| // If no source is provided, or that source is not registered, process next attribute. | ||
| if ( ! isset( $block_binding['source'] ) || ! is_string( $block_binding['source'] ) ) { | ||
| continue; | ||
| } | ||
|
|
||
| $block_binding_source = get_block_bindings_source( $block_binding['source'] ); | ||
| if ( null === $block_binding_source ) { | ||
| continue; | ||
| } | ||
|
|
||
| $source_callback = $block_binding_source['get_value_callback']; | ||
| $source_args = ! empty( $block_binding['args'] ) && is_array( $block_binding['args'] ) ? $block_binding['args'] : array(); | ||
| $source_value = call_user_func_array( $source_callback, array( $source_args, $block_instance, $attribute_name ) ); | ||
|
|
||
| // If the value is not null, process the HTML based on the block and the attribute. | ||
| if ( ! is_null( $source_value ) ) { | ||
| $modified_block_content = gutenberg_block_bindings_replace_html( $modified_block_content, $block_instance->name, $attribute_name, $source_value ); | ||
| } | ||
| } | ||
|
|
||
| return $modified_block_content; | ||
| } | ||
|
|
||
|
|
||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would also add this on the
WP_Block_Bindings_Registry::register()methodThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done in this commit: link.