On this page
WP_REST_Controller::add_additional_fields_schema( array $schema ): array
Adds the schema from additional fields to a schema array.
Description
The type of object is inferred from the passed schema.
Parameters
$schemaarray Required-
Schema array.
Return
array Modified Schema array.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-controller.php. View all references
protected function add_additional_fields_schema( $schema ) {
if ( empty( $schema['title'] ) ) {
return $schema;
}
// Can't use $this->get_object_type otherwise we cause an inf loop.
$object_type = $schema['title'];
$additional_fields = $this->get_additional_fields( $object_type );
foreach ( $additional_fields as $field_name => $field_options ) {
if ( ! $field_options['schema'] ) {
continue;
}
$schema['properties'][ $field_name ] = $field_options['schema'];
}
return $schema;
}
Related
Uses
| Uses | Description |
|---|---|
| WP_REST_Controller::get_additional_fields() wp-includes/rest-api/endpoints/class-wp-rest-controller.php | Retrieves all of the registered additional fields for a given object-type. |
Used By
| Used By | Description |
|---|---|
| WP_REST_Controller::get_item_schema() wp-includes/rest-api/endpoints/class-wp-rest-controller.php | Retrieves the item’s schema, conforming to JSON Schema. |
Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_controller/add_additional_fields_schema