WP_REST_Controller::add_additional_fields_to_object() │ protected │ WP 4.7.0

Adds the values from additional fields to a data object.

Method of the class: WP_REST_Controller{}

No Hooks.

Return

Array. Modified data object with additional fields.

Usage

// protected - for code of main (parent) or child class
$result = $this->add_additional_fields_to_object( $response_data, $request );

$response_data(array) (required)

Prepared response array.

$request(WP_REST_Request) (required)

Full details about the request.

Changelog

WP_REST_Controller::add_additional_fields_to_object() WP REST Controller::add additional fields to object code ^{WP 6.5.2}

protected function add_additional_fields_to_object( $response_data, $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;
		}

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

	return $response_data;
}