From 2ca2feff15f0b18353913055083f037eb2775290 Mon Sep 17 00:00:00 2001 From: gziolo Date: Wed, 19 May 2021 13:52:00 +0000 Subject: [PATCH] Editor: Extend `register_block_type` to accept the path file or folder with `block.json` Rather than using two distinct methods to register block types in WordPress core, let's make `register_block_type` the canonical method to deal with all use cases. In practice, the patch proposed extends its usage to work as a proxy to `register_block_type_from_metadata`. It should remove some confusion that we observed and let us be more explicit what's the latest recommendation. Props matveb, mcsf. Fixes #53233. Built from https://develop.svn.wordpress.org/trunk@50927 git-svn-id: http://core.svn.wordpress.org/trunk@50536 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/blocks.php | 72 ++++++++++++++++++++---------------- wp-includes/blocks/index.php | 2 +- wp-includes/version.php | 2 +- 3 files changed, 42 insertions(+), 34 deletions(-) diff --git a/wp-includes/blocks.php b/wp-includes/blocks.php index e9dcdfbf7c..0346659ad6 100644 --- a/wp-includes/blocks.php +++ b/wp-includes/blocks.php @@ -7,36 +7,6 @@ * @since 5.0.0 */ -/** - * Registers a block type. - * - * @since 5.0.0 - * - * @param string|WP_Block_Type $name Block type name including namespace, or alternatively - * a complete WP_Block_Type instance. In case a WP_Block_Type - * is provided, the $args parameter will be ignored. - * @param array $args Optional. Array of block type arguments. Accepts any public property - * of `WP_Block_Type`. See WP_Block_Type::__construct() for information - * on accepted arguments. Default empty array. - * @return WP_Block_Type|false The registered block type on success, or false on failure. - */ -function register_block_type( $name, $args = array() ) { - return WP_Block_Type_Registry::get_instance()->register( $name, $args ); -} - -/** - * Unregisters a block type. - * - * @since 5.0.0 - * - * @param string|WP_Block_Type $name Block type name including namespace, or alternatively - * a complete WP_Block_Type instance. - * @return WP_Block_Type|false The unregistered block type on success, or false on failure. - */ -function unregister_block_type( $name ) { - return WP_Block_Type_Registry::get_instance()->unregister( $name ); -} - /** * Removes the block asset's path prefix if provided. * @@ -204,7 +174,7 @@ function register_block_style_handle( $metadata, $field_name ) { } /** - * Registers a block type from metadata stored in the `block.json` file. + * Registers a block type from the metadata stored in the `block.json` file. * * @since 5.5.0 * @@ -348,12 +318,50 @@ function register_block_type_from_metadata( $file_or_folder, $args = array() ) { $metadata ); - return register_block_type( + return WP_Block_Type_Registry::get_instance()->register( $metadata['name'], $settings ); } +/** + * Registers a block type. The recommended way is to register a block type using + * the metadata stored in the `block.json` file. + * + * @since 5.0.0 + * + * @param string|WP_Block_Type $block_type Block type name including namespace, or alternatively + * a path to the JSON file with metadata definition for the block, + * or a path to the folder where the `block.json` file is located, + * or a complete WP_Block_Type instance. + * In case a WP_Block_Type is provided, the $args parameter will be ignored. + * @param array $args Optional. Array of block type arguments. Accepts any public property + * of `WP_Block_Type`. See WP_Block_Type::__construct() for information + * on accepted arguments. Default empty array. + * + * @return WP_Block_Type|false The registered block type on success, or false on failure. + */ +function register_block_type( $block_type, $args = array() ) { + if ( is_string( $block_type ) && file_exists( $block_type ) ) { + return register_block_type_from_metadata( $block_type, $args ); + } + + return WP_Block_Type_Registry::get_instance()->register( $block_type, $args ); +} + +/** + * Unregisters a block type. + * + * @since 5.0.0 + * + * @param string|WP_Block_Type $name Block type name including namespace, or alternatively + * a complete WP_Block_Type instance. + * @return WP_Block_Type|false The unregistered block type on success, or false on failure. + */ +function unregister_block_type( $name ) { + return WP_Block_Type_Registry::get_instance()->unregister( $name ); +} + /** * Determine whether a post or content string has blocks. * diff --git a/wp-includes/blocks/index.php b/wp-includes/blocks/index.php index 215d7c20f8..d3905f137f 100644 --- a/wp-includes/blocks/index.php +++ b/wp-includes/blocks/index.php @@ -59,7 +59,7 @@ function register_core_block_types_from_metadata() { ); foreach ( $block_folders as $block_folder ) { - register_block_type_from_metadata( + register_block_type( ABSPATH . WPINC . '/blocks/' . $block_folder ); } diff --git a/wp-includes/version.php b/wp-includes/version.php index a62a6e242f..22e85773c6 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -13,7 +13,7 @@ * * @global string $wp_version */ -$wp_version = '5.8-alpha-50926'; +$wp_version = '5.8-alpha-50927'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.