sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

REST API: Support the (min|max)Length JSON Schema keywords.

Browse Source 
Props sorenbronsted.
Fixes #48820.


git-svn-id: https://develop.svn.wordpress.org/trunk@47627 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Timothy Jacobs 2020-04-27 02:27:02 +00:00
parent 3a229d0b47
commit 86cbde382a
2 changed files with 77 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1337,9 +1337,35 @@ function rest_validate_value_from_schema( $value, $args, $param = '' ) {
return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not of type %2$s.' ), $param, 'boolean' ) );
}
if ( 'string' === $args['type'] && ! is_string( $value ) ) {
/* translators: 1: Parameter, 2: Type name. */
return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not of type %2$s.' ), $param, 'string' ) );
if ( 'string' === $args['type'] ) {
if ( ! is_string( $value ) ) {
/* translators: 1: Parameter, 2: Type name. */
return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not of type %2$s.' ), $param, 'string' ) );
}
if ( isset( $args['minLength'] ) && mb_strlen( $value ) < $args['minLength'] ) {
return new WP_Error(
'rest_invalid_param',
sprintf(
/* translators: 1: Parameter, 2: Number of characters. */
_n( '%1$s must be at least %2$s character long.', '%1$s must be at least %2$s characters long.', $args['minLength'] ),
$param,
number_format_i18n( $args['minLength'] )
)
);
}
if ( isset( $args['maxLength'] ) && mb_strlen( $value ) > $args['maxLength'] ) {
return new WP_Error(
'rest_invalid_param',
sprintf(
/* translators: 1: Parameter, 2: Number of characters. */
_n( '%1$s must be at most %2$s character long.', '%1$s must be at most %2$s characters long.', $args['maxLength'] ),
$param,
number_format_i18n( $args['maxLength'] )
)
);
}
}
if ( isset( $args['format'] ) ) {

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

@ -348,4 +348,52 @@ class WP_Test_REST_Schema_Validation extends WP_UnitTestCase {
$this->assertTrue( rest_validate_value_from_schema( array( 'raw' => 'My Value' ), $schema ) );
$this->assertWPError( rest_validate_value_from_schema( array( 'raw' => array( 'a list' ) ), $schema ) );
}
/**
* @ticket 48820
*/
public function test_string_min_length() {
$schema = array(
'type' => 'string',
'minLength' => 2,
);
// longer
$this->assertTrue( rest_validate_value_from_schema( 'foo', $schema ) );
// exact
$this->assertTrue( rest_validate_value_from_schema( 'fo', $schema ) );
// non-strings does not validate
$this->assertWPError( rest_validate_value_from_schema( 1, $schema ) );
// to short
$this->assertWPError( rest_validate_value_from_schema( 'f', $schema ) );
// one supplementary Unicode code point is not long enough
$mb_char = mb_convert_encoding( '&#x1000;', 'UTF-8', 'HTML-ENTITIES' );
$this->assertWPError( rest_validate_value_from_schema( $mb_char, $schema ) );
// two supplementary Unicode code point is long enough
$this->assertTrue( rest_validate_value_from_schema( $mb_char . $mb_char, $schema ) );
}
/**
* @ticket 48820
*/
public function test_string_max_length() {
$schema = array(
'type' => 'string',
'maxLength' => 2,
);
// shorter
$this->assertTrue( rest_validate_value_from_schema( 'f', $schema ) );
// exact
$this->assertTrue( rest_validate_value_from_schema( 'fo', $schema ) );
// to long
$this->assertWPError( rest_validate_value_from_schema( 'foo', $schema ) );
// non string
$this->assertWPError( rest_validate_value_from_schema( 100, $schema ) );
// two supplementary Unicode code point is long enough
$mb_char = mb_convert_encoding( '&#x1000;', 'UTF-8', 'HTML-ENTITIES' );
$this->assertTrue( rest_validate_value_from_schema( $mb_char, $schema ) );
// three supplementary Unicode code point is to long
$this->assertWPError( rest_validate_value_from_schema( $mb_char . $mb_char . $mb_char, $schema ) );
}
}