rest_validate_number_value_from_schema( mixed $value, array $args, string $param ): true|WP_Error

Compatibility

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_number_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

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

14–92

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 237.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost rest_validate_number_value_from_schema() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 2

• __()Retrieves the translation of $text.
• WP_Error::__construct()Initializes the error.

Used by · 2

• rest_validate_integer_value_from_schema()Validates an integer value based on a schema.
• rest_validate_value_from_schema()Validate a value based on a schema.

Source code

View on Trac ↗View on GitHub ↗

2557function rest_validate_number_value_from_schema( $value, $args, $param ) {2558	if ( ! is_numeric( $value ) ) {2559		return new WP_Error(2560			'rest_invalid_type',2561			/* translators: 1: Parameter, 2: Type name. */2562			sprintf( __( '%1$s is not of type %2$s.' ), $param, $args['type'] ),2563			array( 'param' => $param )2564		);2565	}2566 2567	if ( isset( $args['multipleOf'] ) && fmod( $value, $args['multipleOf'] ) !== 0.0 ) {2568		return new WP_Error(2569			'rest_invalid_multiple',2570			/* translators: 1: Parameter, 2: Multiplier. */2571			sprintf( __( '%1$s must be a multiple of %2$s.' ), $param, $args['multipleOf'] )2572		);2573	}2574 2575	if ( isset( $args['minimum'] ) && ! isset( $args['maximum'] ) ) {2576		if ( ! empty( $args['exclusiveMinimum'] ) && $value <= $args['minimum'] ) {2577			return new WP_Error(2578				'rest_out_of_bounds',2579				/* translators: 1: Parameter, 2: Minimum number. */2580				sprintf( __( '%1$s must be greater than %2$d' ), $param, $args['minimum'] )2581			);2582		}2583 2584		if ( empty( $args['exclusiveMinimum'] ) && $value < $args['minimum'] ) {2585			return new WP_Error(2586				'rest_out_of_bounds',2587				/* translators: 1: Parameter, 2: Minimum number. */2588				sprintf( __( '%1$s must be greater than or equal to %2$d' ), $param, $args['minimum'] )2589			);2590		}2591	}2592 2593	if ( isset( $args['maximum'] ) && ! isset( $args['minimum'] ) ) {2594		if ( ! empty( $args['exclusiveMaximum'] ) && $value >= $args['maximum'] ) {2595			return new WP_Error(2596				'rest_out_of_bounds',2597				/* translators: 1: Parameter, 2: Maximum number. */2598				sprintf( __( '%1$s must be less than %2$d' ), $param, $args['maximum'] )2599			);2600		}2601 2602		if ( empty( $args['exclusiveMaximum'] ) && $value > $args['maximum'] ) {2603			return new WP_Error(2604				'rest_out_of_bounds',2605				/* translators: 1: Parameter, 2: Maximum number. */2606				sprintf( __( '%1$s must be less than or equal to %2$d' ), $param, $args['maximum'] )2607			);2608		}2609	}2610 2611	if ( isset( $args['minimum'], $args['maximum'] ) ) {2612		if ( ! empty( $args['exclusiveMinimum'] ) && ! empty( $args['exclusiveMaximum'] ) ) {2613			if ( $value >= $args['maximum'] || $value <= $args['minimum'] ) {2614				return new WP_Error(2615					'rest_out_of_bounds',2616					sprintf(2617						/* translators: 1: Parameter, 2: Minimum number, 3: Maximum number. */2618						__( '%1$s must be between %2$d (exclusive) and %3$d (exclusive)' ),2619						$param,2620						$args['minimum'],2621						$args['maximum']2622					)2623				);2624			}2625		}2626 2627		if ( ! empty( $args['exclusiveMinimum'] ) && empty( $args['exclusiveMaximum'] ) ) {2628			if ( $value > $args['maximum'] || $value <= $args['minimum'] ) {2629				return new WP_Error(2630					'rest_out_of_bounds',2631					sprintf(2632						/* translators: 1: Parameter, 2: Minimum number, 3: Maximum number. */2633						__( '%1$s must be between %2$d (exclusive) and %3$d (inclusive)' ),2634						$param,2635						$args['minimum'],2636						$args['maximum']

Changelog

Introduced in 5.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.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.