Changeset 56676

Timestamp:

09/25/2023 10:00:33 AM (7 months ago)

Author:

gziolo

Message:

REST API: Improve the block type schema for the name field

Align the schema between block.json defined in Gutenberg and the REST API endpoint for block types. It looks like the name field isn't validated in all places and when it uses pattern matching in the REST API code, then it was slightly different.

Props spacedmonkey, ockham.
See #59346.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-types-controller.php (modified) (6 diffs)

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

@@ -16 +16 @@
  */
 class WP_REST_Block_Types_Controller extends WP_REST_Controller {
+
+    const NAME_PATTERN = '^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$';
 
     /**
@@ -403 +405 @@
                         'description' => __( 'The name of the inner block.' ),
                         'type'        => 'string',
+                        'pattern'     => self::NAME_PATTERN,
+                        'required'    => true,
                     ),
                     'attributes'  => array(
@@ -480 +484 @@
                     'description' => __( 'Unique name identifying the block type.' ),
                     'type'        => 'string',
-                    'default'     => '',
+                    'pattern'     => self::NAME_PATTERN,
+                    'required'    => true,
                     'context'     => array( 'embed', 'view', 'edit' ),
                     'readonly'    => true,
@@ -690 +695 @@
                     'type'        => array( 'array', 'null' ),
                     'items'       => array(
-                        'type' => 'string',
+                        'type'    => 'string',
+                        'pattern' => self::NAME_PATTERN,
                     ),
                     'default'     => null,
@@ -700 +706 @@
                     'type'        => array( 'array', 'null' ),
                     'items'       => array(
-                        'type' => 'string',
+                        'type'    => 'string',
+                        'pattern' => self::NAME_PATTERN,
                     ),
                     'default'     => null,
@@ -712 +719 @@
                     'type'              => 'object',
                     'patternProperties' => array(
-                        '^[a-zA-Z0-9-]+/[a-zA-Z0-9-]+$' => array(
+                        self::NAME_PATTERN => array(
                             'type' => 'string',
                             'enum' => array( 'before', 'after', 'first_child', 'last_child' ),