Changeset 49224

Timestamp:

10/20/2020 07:52:06 AM (4 years ago)

Author:

youknowriad

Message:

Block Editor: Expose api_version in the block type and the REST endpoint.

The new block editor included in 5.6 introduces an api_version property
that indicates which block API version the block is using.
This commits makes this property available on the block type and the endpoint.

Props TimothyBlynJacobs, gziolo.
Fixes #51529.

Location:

trunk

Files:

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

trunk/src/wp-includes/blocks.php

@@ -208 +208 @@
         'styles'          => 'styles',
         'example'         => 'example',
+        'apiVersion'      => 'api_version',
     );
 

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

@@ -16 +16 @@
  */
 class WP_Block_Type {
+
+    /**
+     * Block API version.
+     *
+     * @since 5.6.0
+     * @var int
+     */
+    public $api_version = 1;
 
     /**

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

@@ -257 +257 @@
         $schema       = $this->get_item_schema();
         $extra_fields = array(
+            'api_version',
             'name',
             'title',
@@ -366 +367 @@
             'type'       => 'object',
             'properties' => array(
+                'api_version'            => array(
+                    'description' => __( 'Version of block API.' ),
+                    'type'        => 'integer',
+                    'default'     => 1,
+                    'context'     => array( 'embed', 'view', 'edit' ),
+                    'readonly'    => true,
+                ),
                 'title'            => array(
                     'description' => __( 'Title of block type.' ),

trunk/tests/phpunit/tests/blocks/fixtures/block.json

@@ -1 +1 @@
 {
+    "apiVersion": 2,
     "name": "my-plugin/notice",
     "title": "Notice",

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

@@ -286 +286 @@
 
         $this->assertInstanceOf( 'WP_Block_Type', $result );
+        $this->assertSame( 2, $result->api_version );
         $this->assertSame( 'my-plugin/notice', $result->name );
         $this->assertSame( 'Notice', $result->title );

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

@@ -313 +313 @@
         $data       = $response->get_data();
         $properties = $data['schema']['properties'];
-        $this->assertCount( 19, $properties );
+        $this->assertCount( 20, $properties );
+        $this->assertArrayHasKey( 'api_version', $properties );
         $this->assertArrayHasKey( 'title', $properties );
         $this->assertArrayHasKey( 'icon', $properties );
@@ -432 +433 @@
 
         $extra_fields = array(
+            'api_version',
             'name',
             'category',