Block Bindings: Add block `uses_context` defined by block bindings sources #6079

SantosGuillamot · 2024-02-09T19:36:52Z

This pull request adds some logic to add the necessary uses_context defined by block bindings sources. Each source defines the context it needs and it is added to the blocks that are using the block bindings API.

Apart from that, it adapts the post meta and pattern overrides sources for this change.

Finally, it removes the pattern/overrides from the block.json because it is handled this way now.

Testing instructions

Register a custom field in your site to test it. You can use a code snippet like this:

register_meta(
	'post',
	'url_custom_field',
	array(
		'show_in_rest' => true,
		'single'       => true,
		'type'         => 'string',
		'default'	   => 'https://wpmovies.dev/wp-content/uploads/2023/04/goncharov-poster-original-1-682x1024.jpeg',
	)
);

Post meta source test

Go to a page and insert an image block.
Go to the Code editor and connect the image to the custom field by adding the metadata bindings property. It should look something like this:

<!-- wp:image {"id":134,"sizeSlug":"large","linkDestination":"none","metadata":{"bindings":{"url":{"source":"core/post-meta","args":{"key":"url_custom_field"}},"alt":{"source":"core/post-meta","args":{"key":"text_custom_field"}}}}} -->
<figure class="wp-block-image size-large"><img src="https://wpmovies.dev/wp-content/uploads/2023/04/goncharov-poster-original-1-682x1024.jpeg" alt="Alt content" class="wp-image-134"/></figure>
<!-- /wp:image -->

Save the page and check that in the frontend, the URL defined in the custom field is used.
Repeat the process for paragraph, heading, and button blocks.

Pattern overrides test

Go to Site Editor -> Patterns -> New pattern.
Create a synced pattern and give it a name.
Add a paragraph with a default value and, in the advanced panel, enable the "Allow instance overrides" setting.
Repeat the process with a heading, an image, and a button.
Go to a page and insert the pattern created.
Modify the value of the blocks and save the page.
Go to the frontend and check that the modified values are used.

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

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.

github-actions · 2024-02-09T19:37:09Z

Hi @SantosGuillamot! 👋

Thank you for your contribution to WordPress! 💖

It looks like this is your first pull request to wordpress-develop. Here are a few things to be aware of that may help you out!

No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description.

Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making.

More information about how GitHub pull requests can be used to contribute to WordPress can be found in this blog post.

Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook.

If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook.

The Developer Hub also documents the various coding standards that are followed:

Thank you,
The WordPress Project

github-actions · 2024-02-09T19:37:19Z

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 props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props santosguillamot, gziolo, czapla, thekt12.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

SantosGuillamot · 2024-02-09T19:58:46Z

I guess, according to the tests, that I shouldn't modify the block.json properties, right? Is that imported from Gutenberg somehow?

gziolo · 2024-02-12T08:53:12Z

I guess, according to the tests, that I shouldn't modify the block.json properties, right? Is that imported from Gutenberg somehow?

That needs to happen in the Gutenberg plugin. It isn't as important, so that can be synced later during the 6.5 Beta phase as code quality improvement. You also need to plan to remove these useContext entries from the Gutenberg plugin by syncing back the PHP changes proposed in this patch.

src/wp-includes/block-bindings/post-meta.php

src/wp-includes/class-wp-block-bindings-registry.php

src/wp-includes/class-wp-block.php

src/wp-includes/class-wp-block-bindings-registry.php

michalczaplinski · 2024-02-12T17:13:11Z

src/wp-includes/class-wp-block-bindings-source.php

@@ -60,6 +68,9 @@ public function __construct( string $name, array $source_properties ) {
 		$this->name               = $name;
 		$this->label              = $source_properties['label'];
 		$this->get_value_callback = $source_properties['get_value_callback'];
+		if ( isset( $source_properties['uses_context'] ) ) {


I think that we should move this isset() check next to the other checks
in WP_Block_Bindings_Registry.

And let's cover it with a unit test as well
🙂. (Should be almost a copy-paste of the
existing ones)

My idea is to make the uses_context optional because some sources won't need to use it. Do you think it shouldn't be that case? It would make sense to add a check that, if it exists, it is an array though.

I'll work on unit tests as well 🙂

Yes, it should be optional and default to null.

Right, that makes sense! It should be optional indeed 🙂

If I understood you correctly, I believe I prefer the second option. I made this commit to illustrate how I understood it. We can always revert it.

PD: I included unnecessary code I was using for testing, I just removed it in other commit 😅

Yes, it's exactly how it could work 👍🏻

It would be nice to add a unit test for the registry that asserts that it errors when an unknown property is provided.

At the same time, we are closing the source object for an extension, which I'm a bit unsure about, given we might need to change during beta if we figure out it prevents iterations in the Gutenberg plugin. We also miss the following annotation on the class if we decide to go that path:

wordpress-develop/src/wp-includes/class-wp-block-type.php

Line 17 in 7b24083

#[AllowDynamicProperties]

I am unsure about restricting it as well. I can expect we might want to increase it in Gutenberg after external developers create their own sources the same way we need now to include uses_context.

On the other hand, if we allow source to use their own properties, could we face backwards-compatibility issues in the future?

Imagine a source is using a custom property format. And in the future, we want to include it as part of the core properties and we use it somehow as we are doing with uses_context. The source that had a custom property with the same name wouldn't be working as expected, right?

I'll keep thinking about it as I don't have an ultimate answer for now as it's hard to tell what will be needed here.

michalczaplinski · 2024-02-12T17:24:26Z

Let's also make sure that we update the docstrings in:

register() method - link
register_block_bindings_source() function - link

This reverts commit 828dd93.

SantosGuillamot · 2024-02-15T10:31:01Z

I've created a bunch of tests to check uses_context:

Test that the value defined in uses_context is available for the source: link.
Test that using a string in uses_context fails: link.
Test that the result of registering a source has the correct values: link.
Test that multiple sources, with shared context, merge it properly: link.

tests/phpunit/tests/block-bindings/render.php

tests/phpunit/tests/block-bindings/wpBlockBindingsRegistry.php

tests/phpunit/tests/block-bindings/render.php

tests/phpunit/tests/block-bindings/wpBlockBindingsRegistry.php

src/wp-includes/class-wp-block-bindings-registry.php

gziolo

I left some additional feedback to consider, but it's already in good shape overall. Thank you for adding all the changes and covering the unit tests.

gziolo · 2024-02-15T12:03:01Z

src/wp-includes/class-wp-block-bindings-registry.php

+		// Add `uses_context` defined by block bindings sources.
+		add_filter(
+			'get_block_type_uses_context',
+			function ( $uses_context, $block_type ) use ( $source ) {


One more thing here and not a blocker. I believe we should use a class method and unregister the filter when unregistering the source. It would also help with documenting, as we could put all details from inline comments in the PHPDoc.

I'm not entirely sure how that would look in practice, but happy to explore together options. It can be another patch.

This makes sense to me. Although I don't know how it will work 🤔 I was thinking something like this:

/** * Source that is being processed. * * @since 6.5.0 * @var WP_Block_Bindings_Source|false */ private $source; /** * Callback passed to the `get_block_type_uses_context` filter to add the source's `uses_context` to the block. * * @since 6.5.0 * * @param array $uses_context Array of registered uses context for a block type. * @param WP_Block_Type $block_type The full block type object. * @return array Modified array of uses_context with the values provided by the source. */ public function _add_source_uses_context( $uses_context, $block_type ) { $source = $this->source; if ( ! in_array( $block_type->name, $this->supported_blocks, true ) || empty( $source->uses_context ) ) { return $uses_context; } // Use array_values to reset the array keys. return array_values( array_unique( array_merge( $uses_context, $source->uses_context ) ) ); }

But we probably need a different callback name per source.

Anyway, I'll add a task in the tracking issue to handle it 🙂

Co-authored-by: Greg Ziółkowski <grzegorz@gziolo.pl>

gziolo · 2024-02-16T12:54:00Z

Committed with https://core.trac.wordpress.org/changeset/57641.

SantosGuillamot mentioned this pull request Feb 9, 2024

Block Bindings: Add block context needed for bindings in PHP WordPress/gutenberg#58554

Merged

SantosGuillamot marked this pull request as draft February 9, 2024 19:54

gziolo reviewed Feb 12, 2024

View reviewed changes

src/wp-includes/block-bindings/post-meta.php Show resolved Hide resolved

gziolo reviewed Feb 12, 2024

View reviewed changes

src/wp-includes/class-wp-block-bindings-registry.php Outdated Show resolved Hide resolved

gziolo reviewed Feb 12, 2024

View reviewed changes

src/wp-includes/class-wp-block.php Outdated Show resolved Hide resolved

michalczaplinski reviewed Feb 12, 2024

View reviewed changes

src/wp-includes/class-wp-block-bindings-registry.php Outdated Show resolved Hide resolved

michalczaplinski reviewed Feb 12, 2024

View reviewed changes

src/wp-includes/class-wp-block-bindings-registry.php Outdated Show resolved Hide resolved

michalczaplinski reviewed Feb 12, 2024

View reviewed changes

SantosGuillamot added 14 commits February 13, 2024 11:35

Read uses_context defined by sources

63d381f

Add uses_context to post meta source

65e259a

Change post meta $post_id

68ce2a8

Use uses_context in pattern overrides source

ade4119

Fix formatting

5011e16

Move logic to source registration

929afb6

Format latest changes

44125a4

Remove empty line

5a931f4

Revert "Use uses_context in pattern overrides source"

dccef2e

This reverts commit 828dd93.

Add uses_context to pattern overrides source

016ec29

Create get_block_type_uses_context filter

e305f7c

Use get_block_type_uses_context in source registration

49a8b7a

Update docstrings

42575c4

Move supported blocks to private variables

e41ba30

SantosGuillamot force-pushed the fix/add-context-defined-by-block-bindings-sources branch from c4fb33f to e41ba30 Compare February 13, 2024 11:28

SantosGuillamot added 2 commits February 13, 2024 12:35

Remove unnecessary attributes from variable

4ca8176

Change $support_blocks comment

46df776

SantosGuillamot added 5 commits February 15, 2024 10:29

Test if the source result object properties are correct

d839f33

Test registration fails when uses_context is string

e82879e

Test merging multiple sources uses_context

102c940

Join variations and uses_context in the same conditional

f4af4f7

Move multiple sources test to a different file

f2b3b3a

SantosGuillamot marked this pull request as ready for review February 15, 2024 10:31

gziolo reviewed Feb 15, 2024

View reviewed changes

tests/phpunit/tests/block-bindings/render.php Outdated Show resolved Hide resolved

gziolo reviewed Feb 15, 2024

View reviewed changes

tests/phpunit/tests/block-bindings/wpBlockBindingsRegistry.php Outdated Show resolved Hide resolved

gziolo reviewed Feb 15, 2024

View reviewed changes

tests/phpunit/tests/block-bindings/render.php Show resolved Hide resolved

SantosGuillamot added 5 commits February 15, 2024 11:56

Provide error message in uses_context test

4f8668d

Check allowed source properties in the registry

07a7317

Remove register_meta code

f14817f

Remove spaces in $block_content in tests

edaaffa

Check that uses_context increase by three

03e66ee

gziolo reviewed Feb 15, 2024

View reviewed changes

tests/phpunit/tests/block-bindings/wpBlockBindingsRegistry.php Outdated Show resolved Hide resolved

gziolo reviewed Feb 15, 2024

View reviewed changes

tests/phpunit/tests/block-bindings/wpBlockBindingsRegistry.php Show resolved Hide resolved

gziolo reviewed Feb 15, 2024

View reviewed changes

src/wp-includes/class-wp-block-bindings-registry.php Outdated Show resolved Hide resolved

gziolo reviewed Feb 15, 2024

View reviewed changes

src/wp-includes/class-wp-block-bindings-registry.php Outdated Show resolved Hide resolved

gziolo approved these changes Feb 15, 2024

View reviewed changes

gziolo reviewed Feb 15, 2024

View reviewed changes

SantosGuillamot and others added 4 commits February 15, 2024 13:41

Update comment to use third person

0b49cc4

Co-authored-by: Greg Ziółkowski <grzegorz@gziolo.pl>

Don't use $merged_uses_context variable

9838fec

Co-authored-by: Greg Ziółkowski <grzegorz@gziolo.pl>

Change translators comment syntax to match standard

59fde29

Add covers get_uses_context

5f2ddc3

Co-authored-by: Greg Ziółkowski <grzegorz@gziolo.pl>

SantosGuillamot mentioned this pull request Feb 15, 2024

Connecting block attributes and custom fields & Block Bindings API for WP 6.5 WordPress/gutenberg#53300

Closed

42 tasks

gziolo closed this Feb 16, 2024

This was referenced Apr 22, 2024

Tracking issue: Block bindings API WordPress/gutenberg#60954

Open

Block Bindings: Add context needed by block bindings sources during its processing #6456

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Block Bindings: Add block `uses_context` defined by block bindings sources #6079

Block Bindings: Add block `uses_context` defined by block bindings sources #6079

SantosGuillamot commented Feb 9, 2024 •

edited by gziolo

Loading

github-actions bot commented Feb 9, 2024

github-actions bot commented Feb 9, 2024 •

edited

Loading

SantosGuillamot commented Feb 9, 2024

gziolo commented Feb 12, 2024

michalczaplinski Feb 12, 2024

michalczaplinski Feb 12, 2024

SantosGuillamot Feb 13, 2024

gziolo Feb 13, 2024

michalczaplinski Feb 13, 2024

SantosGuillamot Feb 15, 2024

gziolo Feb 15, 2024

SantosGuillamot Feb 15, 2024

SantosGuillamot Feb 15, 2024

gziolo Feb 15, 2024

michalczaplinski commented Feb 12, 2024 •

edited

Loading

SantosGuillamot commented Feb 15, 2024

gziolo left a comment

gziolo Feb 15, 2024 •

edited

Loading

SantosGuillamot Feb 15, 2024

gziolo commented Feb 16, 2024

Block Bindings: Add block uses_context defined by block bindings sources #6079

Block Bindings: Add block uses_context defined by block bindings sources #6079

Conversation

SantosGuillamot commented Feb 9, 2024 • edited by gziolo Loading

Testing instructions

github-actions bot commented Feb 9, 2024

github-actions bot commented Feb 9, 2024 • edited Loading

SantosGuillamot commented Feb 9, 2024

gziolo commented Feb 12, 2024

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

michalczaplinski commented Feb 12, 2024 • edited Loading

SantosGuillamot commented Feb 15, 2024

gziolo left a comment

Choose a reason for hiding this comment

gziolo Feb 15, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gziolo commented Feb 16, 2024

Block Bindings: Add block `uses_context` defined by block bindings sources #6079

Block Bindings: Add block `uses_context` defined by block bindings sources #6079

SantosGuillamot commented Feb 9, 2024 •

edited by gziolo

Loading

github-actions bot commented Feb 9, 2024 •

edited

Loading

michalczaplinski commented Feb 12, 2024 •

edited

Loading

gziolo Feb 15, 2024 •

edited

Loading