rest_validate_string_value_from_schema( mixed $value, array $args, string $param ): true|WP_Error
- Since
- 5.7.0
- Source
wp-includes/rest-api.php:2662
Compatibility
- WordPress
- since 5.7.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$valuemixed- The value to validate.
$argsarray- Schema array to use for validation.
$paramstring- The parameter name, used in error messages.
Return value
true|WP_Error
Performance profile
How much work a call to rest_validate_string_value_from_schema() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 12–44
- Plugin surface
- None
- Called by
- 1
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 104.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()one call below rest_validate_string_value_from_schema()
Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 12 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost rest_validate_string_value_from_schema() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
is_string($value) && !isset($args) | 12 | none |
is_string($value) | 18 | mb_strlen() |
is_string($value) && rest_validate_json_schema_pattern() | 19 | rest_validate_json_schema_pattern() |
!is_string($value) | 20 | __(), sprintf(), param() |
is_string($value) | 24 | mb_strlen(), mb_strlen() |
is_string($value) && rest_validate_json_schema_pattern() | 25 | mb_strlen(), rest_validate_json_schema_pattern() |
is_string($value) && isset($args) && rest_validate_json_schema_pattern() | 31 | mb_strlen(), mb_strlen(), rest_validate_json_schema_pattern() |
is_string($value) && !rest_validate_json_schema_pattern() | 32 | rest_validate_json_schema_pattern(), __(), sprintf() |
is_string($value) && isset($args) | 35–37 | mb_strlen(), _n(), number_format_i18n(), sprintf() |
is_string($value) && !rest_validate_json_schema_pattern() | 38 | mb_strlen(), rest_validate_json_schema_pattern(), __(), sprintf() |
is_string($value) && isset($args) | 43 | mb_strlen(), mb_strlen(), _n(), number_format_i18n(), sprintf() |
is_string($value) && isset($args) && !rest_validate_json_schema_pattern() | 44 | mb_strlen(), mb_strlen(), rest_validate_json_schema_pattern(), __(), sprintf() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 104 instructions, 12–44 executed per call, 7 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 6
- __()Retrieves the translation of $text.
- mb_strlen()Compat function to mimic mb_strlen().
- _n()Translates and retrieves the singular or plural form based on the supplied number.
- number_format_i18n()Converts float number to format based on the locale.
- rest_validate_json_schema_pattern()Validates if the JSON Schema pattern matches a value.
- WP_Error::__construct()Initializes the error.
Used by · 1
- rest_validate_value_from_schema()Validate a value based on a schema.
Source code
function rest_validate_string_value_from_schema( $value, $args, $param ) { if ( ! is_string( $value ) ) { return new WP_Error( 'rest_invalid_type', /* translators: 1: Parameter, 2: Type name. */ sprintf( __( '%1$s is not of type %2$s.' ), $param, 'string' ), array( 'param' => $param ) ); } if ( isset( $args['minLength'] ) && mb_strlen( $value ) < $args['minLength'] ) { return new WP_Error( 'rest_too_short', 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_too_long', 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['pattern'] ) && ! rest_validate_json_schema_pattern( $args['pattern'], $value ) ) { return new WP_Error( 'rest_invalid_pattern', /* translators: 1: Parameter, 2: Pattern. */ sprintf( __( '%1$s does not match pattern %2$s.' ), $param, $args['pattern'] ) ); } return true;}Changelog
Introduced in 5.7.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 tag, from
src/wp-includes/rest-api.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.