Changeset 50927

Timestamp:

05/19/2021 01:50:09 PM (3 years ago)

Author:

gziolo

Message:

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.

Location:

trunk

Files:

• src/wp-includes/blocks.php (modified) (3 diffs)
• src/wp-includes/blocks/index.php (modified) (1 diff)
• tests/phpunit/tests/blocks/register.php (modified) (1 diff)

trunk/src/wp-includes/blocks.php

@@ -7 +7 @@
  * @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 );
-}
 
 /**
@@ -205 +175 @@
 
 /**
- * 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
@@ -349 +319 @@
     );
 
-    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 );
 }
 

trunk/src/wp-includes/blocks/index.php

@@ -60 +60 @@
 
     foreach ( $block_folders as $block_folder ) {
-        register_block_type_from_metadata(
+        register_block_type(
             ABSPATH . WPINC . '/blocks/' . $block_folder
         );

trunk/tests/phpunit/tests/blocks/register.php

@@ -384 +384 @@
 
     /**
+     * @ticket 53233
+     */
+    function test_block_register_block_type_proxy_for_metadata() {
+        $result = register_block_type(
+            DIR_TESTDATA . '/blocks/notice'
+        );
+
+        $this->assertInstanceOf( 'WP_Block_Type', $result );
+        $this->assertSame( 'tests/notice', $result->name );
+    }
+
+    /**
      * @ticket 52301
      */