Changeset 47450 for trunk/src/wp-includes/rest-api.php

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.

File:

• trunk/src/wp-includes/rest-api.php (modified) (3 diffs)

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 );