rest_stabilize_value( mixed $value ): mixed
- Since
- 5.5.0
- Source
wp-includes/rest-api.php:1776
Description
For lists, order is preserved. For objects, properties are reordered alphabetically.
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
$valuemixed- The value to stabilize. Must already be sanitized. Objects should have been converted to arrays.
Return value
mixed- The stabilized value.
Performance profile
How much work a call to rest_stabilize_value() 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
- Light
- Scaling
- Scales with input
- Instructions
- 4–16
- Plugin surface
- None
- Called by
- 2
Touches nothing outside its own arguments.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 31.
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 it touches
- hookthird-party callbacks
do_action()one call below rest_stabilize_value()
Further down the call graph this can also reach query, option, cache, serialize 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 · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost rest_stabilize_value() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 4–6 | none |
!is_scalar($value) && $value !== null && !is_object($value) | 13–14 | ksort() |
!is_scalar($value) && $value !== null && is_object($value) | 16 | __(), _doing_it_wrong() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 31 | 4–16 | 5 | |
| 8.5 | 31 | 4–16 | 5 | |
| 8.4 | 31 | 4–16 | 5 | |
| 8.3 | 31 | 4–16 | 5 | |
| 8.2 | 31 | 4–16 | 5 | |
| 8.1 | 31 | 4–16 | 5 | 2 fewer instructions than PHP 7.4 |
| 7.4 | 33 | 6–18 | 5 |
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 · 3
- _doing_it_wrong()Marks something as being incorrectly called.
- __()Retrieves the translation of $text.
- rest_stabilize_value()Stabilizes a value following JSON Schema semantics.
Used by · 2
- rest_stabilize_value()Stabilizes a value following JSON Schema semantics.
- rest_validate_array_contains_unique_items()Checks if an array is made up of unique items.
Source code
function rest_stabilize_value( $value ) { if ( is_scalar( $value ) || is_null( $value ) ) { return $value; } if ( is_object( $value ) ) { _doing_it_wrong( __FUNCTION__, __( 'Cannot stabilize objects. Convert the object to an array first.' ), '5.5.0' ); return $value; } ksort( $value ); foreach ( $value as $k => $v ) { $value[ $k ] = rest_stabilize_value( $v ); } return $value;}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 6.8.8 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.