WP_REST_Controller::add_additional_fields_schema() WordPress Method

The WP_REST_Controller::add_additional_fields_schema() method allows you to add additional fields to the JSON schema for a particular REST API endpoint. This is useful if you want to add extra data to the JSON response for a particular endpoint.

WP_REST_Controller::add_additional_fields_schema( array $schema ) #

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

	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
VersionDescription
4.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.