Changeset 47450

Timestamp:

03/12/2020 02:40:29 AM (5 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Introduce "hex-color" JSON Schema format.

Props spacedmonkey, chrisvanpatten.
Fixes #49270.

Location:

trunk

Files:

• src/wp-includes/rest-api.php (modified) (3 diffs)
• tests/phpunit/tests/rest-api/rest-controller.php (modified) (4 diffs)
• tests/phpunit/tests/rest-api/rest-schema-sanitization.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-schema-validation.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-test-controller.php (modified) (1 diff)

trunk/src/wp-includes/rest-api.php

@@ -972 +972 @@
 
 /**
+ * Parses a 3 or 6 digit hex color (with #).
+ *
+ * @since 5.4.0
+ *
+ * @param string $color 3 or 6 digit hex color (with #).
+ * @return string|false
+ */
+function rest_parse_hex_color( $color ) {
+    $regex = '|^#([A-Fa-f0-9]{3}){1,2}$|';
+    if ( ! preg_match( $regex, $color, $matches ) ) {
+        return false;
+    }
+
+    return $color;
+}
+
+/**
  * Parses a date into both its local and UTC equivalent, in MySQL datetime format.
  *
@@ -1328 +1345 @@
     if ( isset( $args['format'] ) ) {
         switch ( $args['format'] ) {
+            case 'hex-color':
+                if ( ! rest_parse_hex_color( $value ) ) {
+                    return new WP_Error( 'rest_invalid_hex_color', __( 'Invalid hex color.' ) );
+                }
+                break;
+
             case 'date-time':
                 if ( ! rest_parse_date( $value ) ) {
@@ -1486 +1509 @@
     if ( isset( $args['format'] ) ) {
         switch ( $args['format'] ) {
+            case 'hex-color':
+                return (string) sanitize_hex_color( $value );
+
             case 'date-time':
                 return sanitize_text_field( $value );

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

@@ -28 +28 @@
                         'type' => 'string',
                     ),
+                    'somehex'     => array(
+                        'type'   => 'string',
+                        'format' => 'hex-color',
+                    ),
                     'someenum'    => array(
                         'type' => 'string',
@@ -164 +168 @@
             'rest_invalid_email',
             rest_validate_request_arg( 'd', $this->request, 'someemail' )
+        );
+    }
+
+    /**
+     * @ticket 49270
+     */
+    public function test_validate_schema_format_hex_color() {
+
+        $this->assertTrue(
+            rest_validate_request_arg( '#000000', $this->request, 'somehex' )
+        );
+
+        $this->assertErrorResponse(
+            'rest_invalid_hex_color',
+            rest_validate_request_arg( 'wibble', $this->request, 'somehex' )
         );
     }
@@ -219 +238 @@
                 'somedate',
                 'someemail',
+                'somehex',
                 'someenum',
                 'someargoptions',
@@ -248 +268 @@
                     'somedate',
                     'someemail',
+                    'somehex',
                     'someenum',
                     'someargoptions',

trunk/tests/phpunit/tests/rest-api/rest-schema-sanitization.php

@@ -78 +78 @@
     }
 
+    /**
+     * @ticket 49270
+     */
+    public function test_format_hex_color() {
+        $schema = array(
+            'type'   => 'string',
+            'format' => 'hex-color',
+        );
+        $this->assertEquals( '#000000', rest_sanitize_value_from_schema( '#000000', $schema ) );
+        $this->assertEquals( '#FFF', rest_sanitize_value_from_schema( '#FFF', $schema ) );
+        $this->assertEquals( '', rest_sanitize_value_from_schema( 'WordPress', $schema ) );
+    }
+
     public function test_type_array() {
         $schema = array(

trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php

@@ -71 +71 @@
         $this->assertTrue( rest_validate_value_from_schema( 'a@b.co', $schema ) );
         $this->assertWPError( rest_validate_value_from_schema( 'email', $schema ) );
+    }
+
+    /**
+     * @ticket 49270
+     */
+    public function test_format_hex_color() {
+        $schema = array(
+            'type'   => 'string',
+            'format' => 'hex-color',
+        );
+        $this->assertTrue( rest_validate_value_from_schema( '#000000', $schema ) );
+        $this->assertTrue( rest_validate_value_from_schema( '#FFF', $schema ) );
+        $this->assertWPError( rest_validate_value_from_schema( 'WordPress', $schema ) );
     }
 

trunk/tests/phpunit/tests/rest-api/rest-test-controller.php

@@ -65 +65 @@
                     'context' => array( 'view' ),
                 ),
+                'somehex'        => array(
+                    'type'    => 'string',
+                    'format'  => 'hex-color',
+                    'context' => array( 'view' ),
+                ),
                 'someenum'       => array(
                     'type'    => 'string',