rest_sanitize_array( mixed $maybe_array ): array
- Since
- 5.5.0
- Source
wp-includes/rest-api.php:1609
Compatibility
- WordPress
- since 5.5.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
$maybe_arraymixed- The value being evaluated.
Return value
array- Returns the array extracted from the value.
Performance profile
How much work a call to rest_sanitize_array() 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
- 6–9
- Plugin surface
- None
- Called by
- 2
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 14.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost rest_sanitize_array() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!is_scalar($maybe_array) && !is_array($maybe_array) | 6 | none |
is_scalar($maybe_array) | 7 | wp_parse_list() |
!is_scalar($maybe_array) && is_array($maybe_array) | 9 | array_values() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 14 | 6–9 | 2 | |
| 8.5 | 14 | 6–9 | 2 | |
| 8.4 | 14 | 6–9 | 2 | |
| 8.3 | 14 | 6–9 | 2 | |
| 8.2 | 14 | 6–9 | 2 | |
| 8.1 | 14 | 6–9 | 2 | 2 fewer instructions than PHP 7.4 |
| 7.4 | 16 | 8–11 | 2 |
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 · 1
- wp_parse_list()Converts a comma- or space-separated list of scalar values to an array.
Used by · 2
- rest_sanitize_value_from_schema()Sanitize a value based on a schema.
- rest_validate_array_value_from_schema()Validates an array value based on a schema.
Source code
function rest_sanitize_array( $maybe_array ) { if ( is_scalar( $maybe_array ) ) { return wp_parse_list( $maybe_array ); } if ( ! is_array( $maybe_array ) ) { return array(); } // Normalize to numeric array so nothing unexpected is in the keys. return array_values( $maybe_array );}Changelog
Introduced in 5.5.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 7.0.4 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.