Blocks: Add block bindings registry class

[gziolo]

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

Extracted from #5888. Props to @michalczaplinski and @artemiomorales for most of the work.

---

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]

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]

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

[mukeshpanchal27]

The line break is not needed, similar to the property below.

[mukeshpanchal27]

@gziolo ☝️

[gziolo]

I'll include that change in the next batch of changes planned: #5966.

[michalczaplinski]

This regex is probably a bit too eager. Only alphanumeric characters and hyphens might be too arbitrarily limited. Underscores, dots or colons are all common in technical names. It also doesn't take into account any non-english characters.

I think we should only check whether there is a / present to indicate a namespace and accept any string before- and after.

On another note, the _doing_it_wrong() warnings do not show up in PHP unit tests. I don't know if this is by design or there is another method that could be used here?

[gziolo]

I copied the same logic that the block types registry uses:

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

Lines 64 to 81 in cabfa6f

	if ( preg_match( '/[A-Z]+/', $name ) ) {
	_doing_it_wrong(
	__METHOD__,
	__( 'Block type names must not contain uppercase characters.' ),
	'5.0.0'
	);
	return false;
	}
	$name_matcher = '/^[a-z0-9-]+\/[a-z0-9-]+$/';
	if ( ! preg_match( $name_matcher, $name ) ) {
	_doing_it_wrong(
	__METHOD__,
	__( 'Block type names must contain a namespace prefix. Example: my-plugin/my-custom-block-type' ),
	'5.0.0'
	);
	return false;
	}

I thought it would be good to follow the same pattern for consistency.

On another note, the _doing_it_wrong() warnings do not show up in PHP unit tests. I don't know if this is by design or there is another method that could be used here?

_doing_it_wrong() call should fail the test if the following PHPDoc annotation isn't provided:

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

Line 72 in cabfa6f

* @expectedIncorrectUsage WP_Block_Bindings_Registry::register

[michalczaplinski]

_doing_it_wrong() call should fail the test if the following PHPDoc annotation isn't provided:

I see, thanks!

I copied the same logic that the block types registry uses:

OK, I think that's fine in that case! 👍 Let's not forget to mention it in the documentation. I'll update the docstring for register_block_bindings_source() & registry->register() in #5888 as well.

[gziolo]

Good point. That would be important to have covered 👍

[michalczaplinski]

done in f2a611b