W3cubDocs

/WordPress

WP_REST_Controller::add_additional_fields_to_object( array $prepared, WP_REST_Request $request )

Adds the values from additional fields to a data object.

Parameters

$prepared

(array) (Required) Prepared response array.

$request

(WP_REST_Request) (Required) Full details about the request.

Return

(array) Modified data object with additional fields.

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-controller.php 

protected function add_additional_fields_to_object( $prepared, $request ) {

		$additional_fields = $this->get_additional_fields();

		$requested_fields = $this->get_fields_for_response( $request );

		foreach ( $additional_fields as $field_name => $field_options ) {
			if ( ! $field_options['get_callback'] ) {
				continue;
			}

			if ( ! rest_is_field_included( $field_name, $requested_fields ) ) {
				continue;
			}

			$prepared[ $field_name ] = call_user_func( $field_options['get_callback'], $prepared, $field_name, $request, $this->get_object_type() );
		}

		return $prepared;
	}

Uses

Uses Description
wp-includes/rest-api.php: rest_is_field_included()

Given an array of fields to include in a response, some of which may be nested.fields, determine whether the provided field should be included in the response body.
wp-includes/rest-api/endpoints/class-wp-rest-controller.php: WP_REST_Controller::get_fields_for_response()

Gets an array of fields to be included on the response.
wp-includes/rest-api/endpoints/class-wp-rest-controller.php: WP_REST_Controller::get_object_type()

Retrieves the object type this controller is responsible for managing.
wp-includes/rest-api/endpoints/class-wp-rest-controller.php: WP_REST_Controller::get_additional_fields()

Retrieves all of the registered additional fields for a given object-type.

Changelog

Version Description
4.7.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_controller/add_additional_fields_to_object