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.


Top ↑

Parameters

$schema array Required
Schema array.

Top ↑

Return

array Modified Schema array.


Top ↑

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


Top ↑

Changelog

Changelog
Version Description
4.7.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.