Changeset 47810

Timestamp:

05/16/2020 07:01:49 PM (4 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Support the JSON Schema pattern keyword.

Props jason_the_adams, birgire, sorenbronsted.
Fixes #44949.

Location:

trunk

Files:

• src/wp-includes/rest-api.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-schema-validation.php (modified) (1 diff)

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

@@ -1382 +1382 @@
                 )
             );
+        }
+
+        if ( isset( $args['pattern'] ) ) {
+            $pattern = str_replace( '#', '\\#', $args['pattern'] );
+            if ( ! preg_match( '#' . $pattern . '#u', $value ) ) {
+                /* translators: 1: Parameter, 2: Pattern. */
+                return new WP_Error( 'rest_invalid_pattern', sprintf( __( '%1$s does not match pattern %2$s.' ), $param, $args['pattern'] ) );
+            }
         }
     }

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

@@ -728 +728 @@
         );
     }
+
+    /**
+     * @ticket 44949
+     */
+    public function test_string_pattern() {
+        $schema = array(
+            'type'    => 'string',
+            'pattern' => '^a*$',
+        );
+
+        $this->assertTrue( rest_validate_value_from_schema( 'a', $schema ) );
+        $this->assertWPError( rest_validate_value_from_schema( 'b', $schema ) );
+    }
+
+    /**
+     * @ticket 44949
+     */
+    public function test_string_pattern_with_escaped_delimiter() {
+        $schema = array(
+            'type'    => 'string',
+            'pattern' => '#[0-9]+',
+        );
+
+        $this->assertTrue( rest_validate_value_from_schema( '#123', $schema ) );
+        $this->assertWPError( rest_validate_value_from_schema( '#abc', $schema ) );
+    }
+
+    /**
+     * @ticket 44949
+     */
+    public function test_string_pattern_with_utf8() {
+        $schema = array(
+            'type'    => 'string',
+            'pattern' => '^â{1}$',
+        );
+
+        $this->assertTrue( rest_validate_value_from_schema( 'â', $schema ) );
+        $this->assertWPError( rest_validate_value_from_schema( 'ââ', $schema ) );
+    }
 }