mirror_php/wordpress
1
0
Fork 0
mirror of git://develop.git.wordpress.org/ synced 2025-04-04 20:23:27 +02:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity

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

Browse Source 
Props spacedmonkey, chrisvanpatten.
Fixes #49270.


git-svn-id: https://develop.svn.wordpress.org/trunk@47450 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Timothy Jacobs 2020-03-12 02:40:29 +00:00
parent a44943546c
commit 60edf36394
5 changed files with 78 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/wp-includes/rest-api.php
View File

@ -970,6 +970,23 @@ function rest_parse_date( $date, $force_utc = false ) {
return strtotime( $date );
}
/**
* 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.
*
@ -1327,6 +1344,12 @@ function rest_validate_value_from_schema( $value, $args, $param = '' ) {
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 ) ) {
return new WP_Error( 'rest_invalid_date', __( 'Invalid date.' ) );
@ -1485,6 +1508,9 @@ function rest_sanitize_value_from_schema( $value, $args ) {
if ( isset( $args['format'] ) ) {
switch ( $args['format'] ) {
case 'hex-color':
return (string) sanitize_hex_color( $value );
case 'date-time':
return sanitize_text_field( $value );

21
tests/phpunit/tests/rest-api/rest-controller.php
View File

@ -27,6 +27,10 @@ class WP_Test_REST_Controller extends WP_Test_REST_TestCase {
'somestring' => array(
'type' => 'string',
),
'somehex' => array(
'type' => 'string',
'format' => 'hex-color',
),
'someenum' => array(
'type' => 'string',
'enum' => array( 'a' ),
@ -166,6 +170,21 @@ class WP_Test_REST_Controller extends WP_Test_REST_TestCase {
);
}
/**
* @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' )
);
}
public function test_validate_schema_format_date_time() {
$this->assertTrue(
@ -218,6 +237,7 @@ class WP_Test_REST_Controller extends WP_Test_REST_TestCase {
'someurl',
'somedate',
'someemail',
'somehex',
'someenum',
'someargoptions',
'somedefault',
@ -247,6 +267,7 @@ class WP_Test_REST_Controller extends WP_Test_REST_TestCase {
'someurl',
'somedate',
'someemail',
'somehex',
'someenum',
'someargoptions',
'somedefault',

13
tests/phpunit/tests/rest-api/rest-schema-sanitization.php
View File

@ -77,6 +77,19 @@ class WP_Test_REST_Schema_Sanitization extends WP_UnitTestCase {
$this->assertEquals( '2001:DB8:0:0:8:800:200C:417A', rest_sanitize_value_from_schema( '2001:DB8:0:0:8:800:200C:417A', $schema ) );
}
/**
* @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(
'type' => 'array',

13
tests/phpunit/tests/rest-api/rest-schema-validation.php
View File

@ -72,6 +72,19 @@ class WP_Test_REST_Schema_Validation extends WP_UnitTestCase {
$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 ) );
}
public function test_format_date_time() {
$schema = array(
'type' => 'string',

5
tests/phpunit/tests/rest-api/rest-test-controller.php
View File

@ -64,6 +64,11 @@ class WP_REST_Test_Controller extends WP_REST_Controller {
'format' => 'email',
'context' => array( 'view' ),
),
'somehex' => array(
'type' => 'string',
'format' => 'hex-color',
'context' => array( 'view' ),
),
'someenum' => array(
'type' => 'string',
'enum' => array( 'a', 'b', 'c' ),