W3cubDocs

/WordPress

rest_is_field_included( string $field, array $fields )

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.

Description

If a parent field is passed in, the presence of any nested field within that parent will cause the method to return true. For example "title" will return true if any of title, title.raw or title.rendered is provided.

Parameters

$field

(string) (Required) A field to test for inclusion in the response body.

$fields

(array) (Required) An array of string fields supported by the endpoint.

Return

(bool) Whether to include the field or not.

Source

File: wp-includes/rest-api.php 

function rest_is_field_included( $field, $fields ) {
	if ( in_array( $field, $fields, true ) ) {
		return true;
	}

	foreach ( $fields as $accepted_field ) {
		// Check to see if $field is the parent of any item in $fields.
		// A field "parent" should be accepted if "parent.child" is accepted.
		if ( strpos( $accepted_field, "$field." ) === 0 ) {
			return true;
		}
		// Conversely, if "parent" is accepted, all "parent.child" fields
		// should also be accepted.
		if ( strpos( $field, "$accepted_field." ) === 0 ) {
			return true;
		}
	}

	return false;
}

Used By

Used By Description
wp-includes/rest-api/endpoints/class-wp-rest-block-types-controller.php: WP_REST_Block_Types_Controller::prepare_item_for_response()

Prepares a block type object for serialization.
wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php: WP_REST_Themes_Controller::prepare_item_for_response()

Prepares a single theme output for response.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::prepare_item_for_response()

Prepares a single post output for response.
wp-includes/rest-api/endpoints/class-wp-rest-controller.php: WP_REST_Controller::add_additional_fields_to_object()

Adds the values from additional fields to a data object.

Changelog

Version Description
5.3.0 Introduced.

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