On this page
rest_default_additional_properties_to_false( array $schema ): array
Sets the “additionalProperties” to false by default for all object definitions in the schema.
Parameters
$schemaarray Required-
The schema to modify.
Return
array The modified schema.
Source
File: wp-includes/rest-api.php. View all references
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;
}
Related
Uses
| Uses | Description |
|---|---|
| rest_default_additional_properties_to_false() wp-includes/rest-api.php | Sets the “additionalProperties” to false by default for all object definitions in the schema. |
Used By
| Used By | Description |
|---|---|
| register_theme_feature() wp-includes/theme.php | Registers a theme feature for use in add_theme_support() . |
| rest_default_additional_properties_to_false() wp-includes/rest-api.php | Sets the “additionalProperties” to false by default for all object definitions in the schema. |
| WP_REST_Meta_Fields::default_additional_properties_to_false() wp-includes/rest-api/fields/class-wp-rest-meta-fields.php | Recursively add additionalProperties = false to all objects in a schema if no additionalProperties setting is specified. |
| WP_REST_Settings_Controller::set_additional_properties_to_false() wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php | Recursively add additionalProperties = false to all objects in a schema if no additionalProperties setting is specified. |
| WP_REST_Meta_Fields::get_registered_fields() wp-includes/rest-api/fields/class-wp-rest-meta-fields.php | Retrieves all the registered meta fields. |
| WP_REST_Settings_Controller::get_registered_options() wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php | Retrieves all of the registered options for the Settings API. |
Changelog
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/rest_default_additional_properties_to_false