Changeset 53268

Timestamp:

04/26/2022 09:48:20 AM (3 years ago)

Author:

gziolo

Message:

Editor: Register 'lock' attribute for every block on the server

Backports changes from ​https://github.com/WordPress/gutenberg/pull/40468.

The lock attribute needs to be supported by every block, but currently, it is only done on the client site. As a result, it was causing block rendered API requests to fail when blocks are locked.

Props mamaduka, peterwilsoncc.
See #55567.

Location:

trunk

Files:

• src/wp-includes/class-wp-block-type.php (modified) (2 diffs)
• tests/phpunit/tests/admin/includesPost.php (modified) (1 diff)
• tests/phpunit/tests/blocks/register.php (modified) (1 diff)
• tests/phpunit/tests/blocks/wpBlock.php (modified) (1 diff)
• tests/phpunit/tests/blocks/wpBlockType.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-block-type-controller.php (modified) (2 diffs)

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

@@ -204 +204 @@
      */
     public $style = null;
+
+    /**
+     * Attributes supported by every block.
+     *
+     * @since 6.0.0
+     * @var array
+     */
+    const GLOBAL_ATTRIBUTES = array(
+        'lock' => array( 'type' => 'object' ),
+    );
 
     /**
@@ -356 +366 @@
         $args['name'] = $this->name;
 
+        // Setup attributes if needed.
+        if ( ! isset( $args['attributes'] ) || ! is_array( $args['attributes'] ) ) {
+            $args['attributes'] = array();
+        }
+
+        // Register core attributes.
+        foreach ( static::GLOBAL_ATTRIBUTES as $attr_key => $attr_schema ) {
+            if ( ! array_key_exists( $attr_key, $args['attributes'] ) ) {
+                $args['attributes'][ $attr_key ] = $attr_schema;
+            }
+        }
+
         /**
          * Filters the arguments for registering a block type.

trunk/tests/phpunit/tests/admin/includesPost.php

@@ -845 +845 @@
                 'description' => '',
                 'icon'        => 'text',
+                'attributes'  => array(
+                    'lock' => array( 'type' => 'object' ),
+                ),
                 'usesContext' => array(),
                 'category'    => 'common',

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

@@ -393 +393 @@
                     'selector' => '.message',
                 ),
+                'lock'    => array( 'type' => 'object' ),
             ),
             $result->attributes

trunk/tests/phpunit/tests/blocks/wpBlock.php

@@ -83 +83 @@
 
         $this->assertInstanceOf( WP_Block_Type::class, $block->block_type );
-        $this->assertSame(
-            $block_type_settings['attributes'],
+        $this->assertSameSetsWithIndex(
+            array(
+                'defaulted' => array(
+                    'type'    => 'number',
+                    'default' => 10,
+                ),
+                'lock'      => array( 'type' => 'object' ),
+            ),
             $block->block_type->attributes
         );

trunk/tests/phpunit/tests/blocks/wpBlockType.php

@@ -83 +83 @@
         $this->assertSame( $args['render_callback'], $block_type->render_callback );
         $this->assertSame( $args['foo'], $block_type->foo );
+    }
+
+    /*
+     * @ticket 55567
+     * @covers WP_Block_Type::set_props
+     */
+    public function test_core_attributes() {
+        $block_type = new WP_Block_Type( 'core/fake', array() );
+
+        $this->assertSameSetsWithIndex(
+            array(
+                'lock' => array( 'type' => 'object' ),
+            ),
+            $block_type->attributes
+        );
+    }
+
+    /*
+     * @ticket 55567
+     * @covers WP_Block_Type::set_props
+     */
+    public function test_core_attributes_matches_custom() {
+        $block_type = new WP_Block_Type(
+            'core/fake',
+            array(
+                'attributes' => array(
+                    'lock' => array(
+                        'type' => 'string',
+                    ),
+                ),
+            )
+        );
+
+        // Backward compatibility: Don't override attributes with the same name.
+        $this->assertSameSetsWithIndex(
+            array(
+                'lock' => array( 'type' => 'string' ),
+            ),
+            $block_type->attributes
+        );
     }
 

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

@@ -244 +244 @@
         $this->assertNull( $data['style'] );
         $this->assertSameSets( array(), $data['provides_context'] );
-        $this->assertSameSets( array(), $data['attributes'] );
+        $this->assertSameSetsWithIndex(
+            array(
+                'lock' => array( 'type' => 'object' ),
+            ),
+            $data['attributes']
+        );
         $this->assertSameSets( array( 'invalid_uses_context' ), $data['uses_context'] );
         $this->assertSameSets( array( 'invalid_keywords' ), $data['keywords'] );
@@ -300 +305 @@
         $this->assertNull( $data['editor_style'] );
         $this->assertNull( $data['style'] );
-        $this->assertSameSets( array(), $data['attributes'] );
+        $this->assertSameSetsWithIndex(
+            array(
+                'lock' => array( 'type' => 'object' ),
+            ),
+            $data['attributes']
+        );
         $this->assertSameSets( array(), $data['provides_context'] );
         $this->assertSameSets( array(), $data['uses_context'] );