Changeset 57521

Timestamp:

02/02/2024 12:59:21 PM (15 months ago)

Author:

gziolo

Message:

Editor: Add allowed_blocks field to block registration and REST API

There is a new block.json field called allowedBlocks, added in Gutenberg in ​https://github.com/WordPress/gutenberg/pull/58262. This adds support for this new field also on the server.

Props: gziolo, jsnajdr.
Fixes #60403.

Location:

trunk

Files:

• src/wp-admin/includes/post.php (modified) (1 diff)
• src/wp-includes/blocks.php (modified) (2 diffs)
• src/wp-includes/class-wp-block-type.php (modified) (2 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-block-types-controller.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-block-type-controller.php (modified) (8 diffs)

trunk/src/wp-admin/includes/post.php

@@ -2304 +2304 @@
         'example'          => 'example',
         'variations'       => 'variations',
+        'allowed_blocks'   => 'allowedBlocks',
     );
 

trunk/src/wp-includes/blocks.php

@@ -328 +328 @@
  * @since 6.3.0 Added `selectors` field.
  * @since 6.4.0 Added support for `blockHooks` field.
- * @since 6.5.0 Added support for `viewStyle` field.
+ * @since 6.5.0 Added support for `allowedBlocks` and `viewStyle` fields.
  *
  * @param string $file_or_folder Path to the JSON file with metadata definition for
@@ -425 +425 @@
         'variations'      => 'variations',
         'example'         => 'example',
+        'allowedBlocks'   => 'allowed_blocks',
     );
     $textdomain        = ! empty( $metadata['textdomain'] ) ? $metadata['textdomain'] : null;

trunk/src/wp-includes/class-wp-block-type.php

@@ -68 +68 @@
      */
     public $ancestor = null;
+
+    /**
+     * Limits which block types can be inserted as children of this block type.
+     *
+     * @since 6.5.0
+     * @var string[]|null
+     */
+    public $allowed_blocks = null;
 
     /**
@@ -304 +312 @@
      *     @type string[]|null $ancestor                 Setting ancestor makes a block available only inside the specified
      *                                                   block types at any position of the ancestor's block subtree.
+     *     @type string[]|null $allowed_blocks           Limits which block types can be inserted as children of this block type.
      *     @type string|null   $icon                     Block type icon.
      *     @type string        $description              A detailed block type description.

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-types-controller.php

@@ -281 +281 @@
                 'parent',
                 'ancestor',
+                'allowed_blocks',
                 'provides_context',
                 'uses_context',
@@ -724 +725 @@
                     'readonly'    => true,
                 ),
+                'allowed_blocks'        => array(
+                    'description' => __( 'Allowed child block types.' ),
+                    'type'        => array( 'array', 'null' ),
+                    'items'       => array(
+                        'type'    => 'string',
+                        'pattern' => self::NAME_PATTERN,
+                    ),
+                    'default'     => null,
+                    'context'     => array( 'embed', 'view', 'edit' ),
+                    'readonly'    => true,
+                ),
                 'keywords'              => $keywords_definition,
                 'example'               => $example_definition,

trunk/tests/phpunit/tests/rest-api/rest-block-type-controller.php

@@ -208 +208 @@
             'parent'           => 'invalid_parent',
             'ancestor'         => 'invalid_ancestor',
+            'allowed_blocks'   => 'invalid_allowed_blocks',
             'icon'             => true,
             'description'      => true,
@@ -238 +239 @@
         $this->assertSameSets( array( 'invalid_parent' ), $data['parent'] );
         $this->assertSameSets( array( 'invalid_ancestor' ), $data['ancestor'] );
+        $this->assertSameSets( array( 'invalid_allowed_blocks' ), $data['allowed_blocks'] );
         $this->assertNull( $data['icon'] );
         $this->assertSame( '1', $data['description'] );
@@ -284 +286 @@
             'parent'           => false,
             'ancestor'         => false,
+            'allowed_blocks'   => false,
             'icon'             => false,
             'description'      => false,
@@ -314 +317 @@
         $this->assertSameSets( array(), $data['parent'] );
         $this->assertSameSets( array(), $data['ancestor'] );
+        $this->assertSameSets( array(), $data['allowed_blocks'] );
         $this->assertNull( $data['icon'] );
         $this->assertSame( '', $data['description'] );
@@ -551 +555 @@
      * @ticket 57585
      * @ticket 59346
+     * @ticket 60403
      */
     public function test_get_item_schema() {
@@ -558 +563 @@
         $data       = $response->get_data();
         $properties = $data['schema']['properties'];
-        $this->assertCount( 31, $properties );
+        $this->assertCount( 32, $properties );
         $this->assertArrayHasKey( 'api_version', $properties );
         $this->assertArrayHasKey( 'name', $properties );
@@ -565 +570 @@
         $this->assertArrayHasKey( 'parent', $properties );
         $this->assertArrayHasKey( 'ancestor', $properties );
+        $this->assertArrayHasKey( 'allowed_blocks', $properties );
         $this->assertArrayHasKey( 'icon', $properties );
         $this->assertArrayHasKey( 'description', $properties );
@@ -697 +703 @@
             'parent',
             'ancestor',
+            'allowedBlocks',
             'icon',
             'description',