wppaste
WordPress

WP_REST_Settings_Controller::set_additional_properties_to_false( array $schema ): array

Since
4.9.0
Source
wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php:338
Recursively add additionalProperties = false to all objects in a schema if no additionalProperties setting is specified.

Description

This is needed to restrict properties of objects in settings values to only registered items, as the REST API will allow additional properties by default.

Compatibility

Deprecated in WordPress 6.1.0. Use {@see rest_default_additional_properties_to_false()} instead.

WordPress
since 4.9.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 array.

Return value

array

Performance profile

How much work a call to WP_REST_Settings_Controller::set_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
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
10

Executed per call on PHP 8.5. The body compiles to 10.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • hookthird-party callbacksdo_action()one call below WP_REST_Settings_Controller::set_additional_properties_to_false()

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 · 1 distinct outcome

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

WhenInstructionsCalls it makes
always10_deprecated_function(), rest_default_additional_properties_to_false()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 10 instructions, 10 executed per call, 0 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 · 2

Source code

View on Trac View on GitHub 

	protected function set_additional_properties_to_false( $schema ) {		_deprecated_function( __METHOD__, '6.1.0', 'rest_default_additional_properties_to_false()' ); 		return rest_default_additional_properties_to_false( $schema );	}

Changelog

Introduced in 4.9.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.

6.1.0
Deprecated. Use rest_default_additional_properties_to_false() instead.from the docblock
4.9.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.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.