A WordPress-centric search engine for devs and theme authors



rest_default_additional_properties_to_false ›

Since5.5.0
Deprecatedn/a
rest_default_additional_properties_to_false ( $schema )
Parameters:
  • (array) $schema The schema to modify.
    Required: Yes
Returns:
  • (array) The modified schema.
Defined at:
Codex:

Sets the "additionalProperties" to false by default for all object definitions in the schema.



Source

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['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;
}