rest_default_additional_properties_to_false( array $schema ): array
- Since
- 5.5.0, 5.6.0
- Source
wp-includes/rest-api.php:3192
Compatibility
- WordPress
- since 5.6.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
$schemaarray- The schema to modify.
Return value
array- The modified schema.
Performance profile
How much work a call to rest_default_additional_properties_to_false() 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
- 10–35
- Plugin surface
- None
- Called by
- 6
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 51.
Nothing here hands control to plugin code.
6 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_default_additional_properties_to_false() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 10–28 | none |
$type && isset($schema) | 19–35 | rest_default_additional_properties_to_false() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 51 | 10–35 | 10 | |
| 8.5 | 51 | 10–35 | 10 | |
| 8.4 | 51 | 10–35 | 10 | 6 fewer instructions than PHP 8.3 |
| 8.3 | 57 | 16–41 | 10 | |
| 8.2 | 57 | 16–41 | 10 | |
| 8.1 | 57 | 16–41 | 10 | |
| 7.4 | 57 | 16–41 | 10 |
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
- rest_default_additional_properties_to_false()Sets the "additionalProperties" to false by default for all object definitions in the schema.
Used by · 6
- WP_REST_Meta_Fields::default_additional_properties_to_false()Recursively add additionalProperties = false to all objects in a schema if no additionalProperties setting is specified.
- WP_REST_Meta_Fields::get_registered_fields()Retrieves all the registered meta fields.
- WP_REST_Settings_Controller::get_registered_options()Retrieves all of the registered options for the Settings API.
- WP_REST_Settings_Controller::set_additional_properties_to_false()Recursively add additionalProperties = false to all objects in a schema if no additionalProperties setting is specified.
- register_theme_feature()Registers a theme feature for use in add_theme_support().
- rest_default_additional_properties_to_false()Sets the "additionalProperties" to false by default for all object definitions in the schema.
Source code
function rest_default_additional_properties_to_false( $schema ) { $type = (array) $schema['type']; if ( in_array( 'object', $type, true ) ) { if ( isset( $schema['properties'] ) ) { foreach ( $schema['properties'] as $key => $child_schema ) { $schema['properties'][ $key ] = rest_default_additional_properties_to_false( $child_schema ); } } if ( isset( $schema['patternProperties'] ) ) { foreach ( $schema['patternProperties'] as $key => $child_schema ) { $schema['patternProperties'][ $key ] = rest_default_additional_properties_to_false( $child_schema ); } } if ( ! isset( $schema['additionalProperties'] ) ) { $schema['additionalProperties'] = false; } } if ( in_array( 'array', $type, true ) ) { if ( isset( $schema['items'] ) ) { $schema['items'] = rest_default_additional_properties_to_false( $schema['items'] ); } } return $schema;}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.1.0 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.