Block bindings: Expose sources in the editor settings to consume them in the client #7020

SantosGuillamot · 2024-07-12T11:25:51Z

Originally explored in this other pull request: #6456

What?

It adds a new property to the editor settings to expose the block bindings sources registered in the server. This allows to reuse some of its properties like label and uses_context without having to replicate that in JavaScript.

There is a related pull request in Gutenberg, where these settings are being consumed.

Why?

It makes some block bindings editor functionalities work by default, improving the user experience, and it simplifies how sources are registered in the client.

How?

Add a new property including all the registered sources while the editor settings are being initialized.

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

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-07-12T11:26:11Z

Trac Ticket Missing

This pull request is missing a link to a Trac ticket. For a contribution to be considered, there must be a corresponding ticket in Trac.

To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description. More information about contributing to WordPress on GitHub can be found in the Core Handbook.

src/wp-includes/block-editor.php

github-actions · 2024-07-12T11:26:16Z

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, cbravobernal, gziolo, artemiosans.

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

github-actions · 2024-07-12T11:38:40Z

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

The Plugin and Theme Directories cannot be accessed within Playground.
All changes will be lost when closing a tab with a Playground instance.
All changes will be lost when refreshing the page.
A fresh instance is created each time the link below is clicked.
Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

gziolo · 2024-07-22T09:56:54Z

I’m wondering if we can update an existing unit test to validate the setting is correctly propagated to the editor

Maybe something similar to

wordpress-develop/tests/phpunit/tests/blocks/editor.php

Lines 468 to 473 in dea027e

    
           public function test_get_block_editor_settings_theme_json_settings() { 
        
           	switch_theme( 'block-theme' ); 
        
           	$post_editor_context = new WP_Block_Editor_Context( array( 'post' => get_post() ) ); 
        
           	$settings = get_block_editor_settings( array(), $post_editor_context );

, but a simpler one as no theme switching is necessary.

tests/phpunit/tests/blocks/editor.php

SantosGuillamot · 2024-07-22T12:32:30Z

I’m wondering if we can update an existing unit test to validate the setting is correctly propagated to the editor

I have just added this new unit test to check that the registered sources are properly added to the editor settings: link.

tests/phpunit/tests/blocks/editor.php

artemiomorales

Looks good to me 👍

gziolo

I'm very excited about the work that exposes the sources from the server, as we will have a better information to share with users about sources, and an improved handling for the necessary block context.

gziolo · 2024-07-23T07:52:56Z

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

@@ -77,6 +77,9 @@ public function test_get_all_registered() {
 		);

 		$registered = get_all_registered_block_bindings_sources();
+		unregister_block_bindings_source( 'test/source-one' );


These lines are redundant as there is automated cleanup included in the tear_down lifecycle method:

wordpress-develop/tests/phpunit/tests/block-bindings/register.php

Lines 38 to 43 in a18de61

public function tear_down() {

foreach ( get_all_registered_block_bindings_sources() as $source_name => $source_properties ) {

if ( str_starts_with( $source_name, 'test/' ) ) {

unregister_block_bindings_source( $source_name );

}

}

That makes sense 🙂 And it explains why they weren't failing before. I made this change as part of this commit.

gziolo · 2024-07-23T07:55:11Z

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

@@ -269,6 +269,9 @@ public function test_get_all_registered() {
 		);

 		$registered = $this->registry->get_all_registered();
+		$this->registry->unregister( 'test/source-one' );


This one is more nuanced, but also redundant. There is a new instance of the registry created for every test using the lifecycle method set_up:

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

Line 33 in a18de61

$this->registry = new WP_Block_Bindings_Registry();

So, the instance with registered custom sources doesn't persist between tests.

Makes sense as well 🙂 I made this change as part of this commit.

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

tests/phpunit/tests/blocks/editor.php

cbravobernal · 2024-07-24T10:59:10Z

Completed with my first commit to Core in https://core.trac.wordpress.org/changeset/58798

noisysocks · 2024-07-26T05:57:33Z

Thanks for committing this early in the 6.7 cycle ❤️

Add sources to editor settings

c069da7

SantosGuillamot added the enhancement label Jul 12, 2024

SantosGuillamot requested review from gziolo and cbravobernal July 12, 2024 11:25

SantosGuillamot commented Jul 12, 2024

View reviewed changes

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

SantosGuillamot mentioned this pull request Jul 12, 2024

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

Closed

SantosGuillamot mentioned this pull request Jul 13, 2024

Block Bindings iteration for WordPress 6.7 WordPress/gutenberg#63018

Closed

64 tasks

Use blockBindingsSource name

876155f

SantosGuillamot mentioned this pull request Jul 16, 2024

Block Bindings: Bootstrap sources defined in the server WordPress/gutenberg#63470

Merged

Add unit test to check editor settings

745509a

SantosGuillamot commented Jul 22, 2024

View reviewed changes

tests/phpunit/tests/blocks/editor.php Outdated Show resolved Hide resolved

SantosGuillamot added 2 commits July 22, 2024 15:01

Adapt test to check only expected properties

ac767be

Register sources in unit test

2b2bed5

gziolo reviewed Jul 22, 2024

View reviewed changes

tests/phpunit/tests/blocks/editor.php Show resolved Hide resolved

Unregister sources in tests

a18de61

github-actions bot mentioned this pull request Jul 23, 2024

PHP backports for WP 6.7 WordPress/gutenberg#63827

Open

artemiomorales approved these changes Jul 23, 2024

View reviewed changes

gziolo approved these changes Jul 23, 2024

View reviewed changes

Remove unnecessary unregister

f258a46

cbravobernal closed this Jul 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Block bindings: Expose sources in the editor settings to consume them in the client #7020

Block bindings: Expose sources in the editor settings to consume them in the client #7020

SantosGuillamot commented Jul 12, 2024 •

edited

Loading

github-actions bot commented Jul 12, 2024

github-actions bot commented Jul 12, 2024 •

edited

Loading

github-actions bot commented Jul 12, 2024

gziolo commented Jul 22, 2024 •

edited

Loading

SantosGuillamot commented Jul 22, 2024

artemiomorales left a comment

gziolo left a comment

gziolo Jul 23, 2024

SantosGuillamot Jul 23, 2024

gziolo Jul 23, 2024

SantosGuillamot Jul 23, 2024

cbravobernal commented Jul 24, 2024

noisysocks commented Jul 26, 2024

	public function tear_down() {
	foreach ( get_all_registered_block_bindings_sources() as $source_name => $source_properties ) {
	if ( str_starts_with( $source_name, 'test/' ) ) {
	unregister_block_bindings_source( $source_name );
	}
	}

Block bindings: Expose sources in the editor settings to consume them in the client #7020

Block bindings: Expose sources in the editor settings to consume them in the client #7020

Conversation

SantosGuillamot commented Jul 12, 2024 • edited Loading

What?

Why?

How?

github-actions bot commented Jul 12, 2024

Trac Ticket Missing

github-actions bot commented Jul 12, 2024 • edited Loading

github-actions bot commented Jul 12, 2024

Test using WordPress Playground

Some things to be aware of

gziolo commented Jul 22, 2024 • edited Loading

SantosGuillamot commented Jul 22, 2024

artemiomorales left a comment

Choose a reason for hiding this comment

gziolo left a comment

Choose a reason for hiding this comment

gziolo Jul 23, 2024

Choose a reason for hiding this comment

SantosGuillamot Jul 23, 2024

Choose a reason for hiding this comment

gziolo Jul 23, 2024

Choose a reason for hiding this comment

SantosGuillamot Jul 23, 2024

Choose a reason for hiding this comment

cbravobernal commented Jul 24, 2024

noisysocks commented Jul 26, 2024

SantosGuillamot commented Jul 12, 2024 •

edited

Loading

github-actions bot commented Jul 12, 2024 •

edited

Loading

gziolo commented Jul 22, 2024 •

edited

Loading