Changeset 55673

Timestamp:

04/21/2023 10:41:58 AM (17 months ago)

Author:

gziolo

Message:

Editor: Add selectors field to block type definition

Adds support for the new selectors property for block types. It adds it to the allowed metadata when registering a block type, makes the WP_Block_Type class aware of it, exposes it through the block types REST API, and the get_block_editor_server_block_settings function.

Corresponding work in the Gutenberg plugin: ​https://github.com/WordPress/gutenberg/pull/46496.

Fixes #57585.
Props aaronrobertshaw, hellofromTonya.

Location:

trunk

Files:

• src/wp-admin/includes/post.php (modified) (2 diffs)
• src/wp-includes/blocks.php (modified) (2 diffs)
• src/wp-includes/class-wp-block-type.php (modified) (3 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-block-types-controller.php (modified) (4 diffs)
• tests/phpunit/data/blocks/notice/block.json (modified) (1 diff)
• tests/phpunit/tests/admin/includesPost.php (modified) (2 diffs)
• tests/phpunit/tests/blocks/register.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-block-type-controller.php (modified) (9 diffs)

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

@@ -2179 +2179 @@
  *
  * @since 5.0.0
+ * @since 6.3.0 Added `selectors` field.
  *
  * @return array An associative array of registered block data.
@@ -2193 +2194 @@
         'provides_context' => 'providesContext',
         'uses_context'     => 'usesContext',
+        'selectors'        => 'selectors',
         'supports'         => 'supports',
         'category'         => 'category',

trunk/src/wp-includes/blocks.php

@@ -301 +301 @@
  * @since 5.9.0 Added support for `variations` and `viewScript` fields.
  * @since 6.1.0 Added support for `render` field.
+ * @since 6.3.0 Added `selectors` field.
  *
  * @param string $file_or_folder Path to the JSON file with metadata definition for
@@ -383 +384 @@
         'providesContext' => 'provides_context',
         'usesContext'     => 'uses_context',
+        'selectors'       => 'selectors',
         'supports'        => 'supports',
         'styles'          => 'styles',

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

@@ -117 +117 @@
      */
     public $variations = array();
+
+    /**
+     * Custom CSS selectors for theme.json style generation.
+     *
+     * @since 6.3.0
+     * @var array
+     */
+    public $selectors = array();
 
     /**
@@ -246 +254 @@
      *              `editor_style_handles`, and `style_handles` properties.
      *              Deprecated the `editor_script`, `script`, `view_script`, `editor_style`, and `style` properties.
+     * @since 6.3.0 Added the `selectors` property.
      *
      * @see register_block_type()
@@ -269 +278 @@
      *     @type array[]       $styles                   Alternative block styles.
      *     @type array[]       $variations               Block variations.
+     *     @type array         $selectors                Custom CSS selectors for theme.json style generation.
      *     @type array|null    $supports                 Supported features.
      *     @type array|null    $example                  Structured data for the block preview.

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

@@ -238 +238 @@
      * @since 5.5.0
      * @since 5.9.0 Renamed `$block_type` to `$item` to match parent class for PHP 8 named parameter support.
+     * @since 6.3.0 Added `selectors` field.
      *
      * @param WP_Block_Type   $item    Block type data.
@@ -279 +280 @@
                 'provides_context',
                 'uses_context',
+                'selectors',
                 'supports',
                 'styles',
@@ -380 +382 @@
      *
      * @since 5.5.0
+     * @since 6.3.0 Added `selectors` field.
      *
      * @return array Item schema data.
@@ -516 +519 @@
                         'type' => 'string',
                     ),
+                    'context'     => array( 'embed', 'view', 'edit' ),
+                    'readonly'    => true,
+                ),
+                'selectors'             => array(
+                    'description' => __( 'Custom CSS selectors.' ),
+                    'type'        => 'object',
+                    'default'     => array(),
+                    'properties'  => array(),
                     'context'     => array( 'embed', 'view', 'edit' ),
                     'readonly'    => true,

trunk/tests/phpunit/data/blocks/notice/block.json

@@ -27 +27 @@
             "type": "string"
         }
+    },
+    "selectors": {
+        "root": ".wp-block-notice"
     },
     "supports": {

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

@@ -827 +827 @@
             'render_callback' => 'foo',
             'ancestor'        => array( 'core/test-ancestor' ),
+            'selectors'       => array( 'root' => '.wp-block-test' ),
         );
 
@@ -846 +847 @@
                 ),
                 'usesContext' => array(),
+                'selectors'   => array( 'root' => '.wp-block-test' ),
                 'category'    => 'common',
                 'styles'      => array(),

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

@@ -484 +484 @@
      * @ticket 50263
      * @ticket 50328
+     * @ticket 57585
      */
     public function test_block_registers_with_metadata_fixture() {
@@ -516 +517 @@
         );
         $this->assertSameSets( array( 'groupId' ), $result->uses_context );
+        // @ticket 57585
+        $this->assertSame(
+            array( 'root' => '.wp-block-notice' ),
+            $result->selectors,
+            'Block type should contain selectors from metadata.'
+        );
         $this->assertSame(
             array(

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

@@ -197 +197 @@
     /**
      * @ticket 47620
+     * @ticket 57585
      */
     public function test_get_item_invalid() {
@@ -217 +218 @@
             'parent'           => 'invalid_parent',
             'ancestor'         => 'invalid_ancestor',
+            'selectors'        => 'invalid_selectors',
             'supports'         => 'invalid_supports',
             'styles'           => array(),
@@ -248 +250 @@
         $this->assertSameSets( array( 'invalid_parent' ), $data['parent'] );
         $this->assertSameSets( array( 'invalid_ancestor' ), $data['ancestor'] );
+        $this->assertSameSets( array(), $data['selectors'], 'invalid selectors defaults to empty array' );
         $this->assertSameSets( array(), $data['supports'] );
         $this->assertSameSets( array(), $data['styles'] );
@@ -266 +269 @@
     /**
      * @ticket 47620
+     * @ticket 57585
      */
     public function test_get_item_defaults() {
@@ -285 +289 @@
             'parent'           => false,
             'ancestor'         => false,
+            'selectors'        => false,
             'supports'         => false,
             'styles'           => false,
@@ -317 +322 @@
         $this->assertSameSets( array(), $data['parent'] );
         $this->assertSameSets( array(), $data['ancestor'] );
+        $this->assertSameSets( array(), $data['selectors'], 'selectors defaults to empty array' );
         $this->assertSameSets( array(), $data['supports'] );
         $this->assertSameSets( array(), $data['styles'] );
@@ -535 +541 @@
     /**
      * @ticket 47620
+     * @ticket 57585
      */
     public function test_get_item_schema() {
@@ -542 +549 @@
         $data       = $response->get_data();
         $properties = $data['schema']['properties'];
-        $this->assertCount( 28, $properties );
+        $this->assertCount( 29, $properties );
         $this->assertArrayHasKey( 'api_version', $properties );
         $this->assertArrayHasKey( 'title', $properties );
@@ -552 +559 @@
         $this->assertArrayHasKey( 'name', $properties );
         $this->assertArrayHasKey( 'attributes', $properties );
+        $this->assertArrayHasKey( 'selectors', $properties, 'schema must contain selectors' );
         $this->assertArrayHasKey( 'supports', $properties );
         $this->assertArrayHasKey( 'category', $properties );