Changeset 49948

Timestamp:

01/08/2021 04:43:29 PM (4 years ago)

Author:

gziolo

Message:

Editor: Support filtering arguments in block type registration from metadata

Adds 2 new hooks in register_block_type_from_metadata:

• Named block_type_metadata to filter the content of metadata read from block.json
• Named block_type_metadata_settings to filter the settings object determined from the metadata that is passed to register_block_type call

Props swissspidy.
Fixes #52138.

Location:

trunk

Files:

• src/wp-includes/blocks.php (modified) (2 diffs)
• tests/phpunit/tests/blocks/register.php (modified) (2 diffs)

trunk/src/wp-includes/blocks.php

@@ -201 +201 @@
     }
     $metadata['file'] = $metadata_file;
+
+    /**
+     * Filters the metadata provided for registering a block type.
+     *
+     * @since 5.7.0
+     *
+     * @param array $metadata Metadata for registering a block type.
+     */
+    $metadata = apply_filters( 'block_type_metadata', $metadata );
 
     $settings          = array();
@@ -253 +262 @@
     }
 
-    return register_block_type(
-        $metadata['name'],
+    /**
+     * Filters the settings determined from the block type metadata.
+     *
+     * @since 5.7.0
+     *
+     * @param array $settings Array of determined settings for registering a block type.
+     * @param array $metadata Metadata provided for registering a block type.
+     */
+    $settings = apply_filters(
+        'block_type_metadata_settings',
         array_merge(
             $settings,
             $args
-        )
+        ),
+        $metadata
+    );
+
+    return register_block_type(
+        $metadata['name'],
+        $settings
     );
 }

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

@@ -63 +63 @@
         $registry = WP_Block_Type_Registry::get_instance();
 
-        foreach ( array( 'test-static', 'test-dynamic' ) as $block_name ) {
-            $block_name = 'core/' . $block_name;
-
+        foreach ( array( 'core/test-static', 'core/test-dynamic', 'my-plugin/notice' ) as $block_name ) {
             if ( $registry->is_registered( $block_name ) ) {
                 $registry->unregister( $block_name );
@@ -424 +422 @@
         $this->assertSame( 'boolean', $block_type->attributes['core/test-filtered']['type'] );
     }
+
+    /**
+     * @ticket 52138
+     */
+    public function test_filter_block_registration_metadata() {
+        $filter_metadata_registration = function( $metadata ) {
+            $metadata['apiVersion'] = 3;
+            return $metadata;
+        };
+
+        add_filter( 'block_type_metadata', $filter_metadata_registration, 10, 2 );
+        $result = register_block_type_from_metadata(
+            __DIR__ . '/fixtures'
+        );
+        remove_filter( 'block_type_metadata', $filter_metadata_registration );
+
+        $this->assertSame( 3, $result->api_version );
+    }
+
+    /**
+     * @ticket 52138
+     */
+    public function test_filter_block_registration_metadata_settings() {
+        $filter_metadata_registration = function( $settings, $metadata ) {
+            $settings['api_version'] = $metadata['apiVersion'] + 1;
+            return $settings;
+        };
+
+        add_filter( 'block_type_metadata_settings', $filter_metadata_registration, 10, 2 );
+        $result = register_block_type_from_metadata(
+            __DIR__ . '/fixtures'
+        );
+        remove_filter( 'block_type_metadata_settings', $filter_metadata_registration );
+
+        $this->assertSame( 3, $result->api_version );
+    }
 }