WordPress at a glance
function is not described

WP_REST_Controller::add_additional_fields_schema() protected WP 4.7.0

Adds the schema from additional fields to a schema array.

The type of object is inferred from the passed schema.

{} It's a method of the class: WP_REST_Controller{}

No Hooks.

Return

Array. Modified Schema array.

Usage

// protected - for code of main (parent) or child class
$result = $this->add_additional_fields_schema( $schema );
$schema(array) (required)
Schema array.

Changelog

Since 4.7.0 Introduced.

Code of WP_REST_Controller::add_additional_fields_schema() WP 5.5.1

<?php
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;
}