WP_REST_Controller::update_additional_fields_for_object

Advertisement

Summery Summery

Updates the values of additional fields added to a data object.

Syntax Syntax

WP_REST_Controller::update_additional_fields_for_object( object $object, WP_REST_Request $request )

Parameters Parameters

$object

(object) (Required) Data model like WP_Term or WP_Post.

$request

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

Return Return

(bool|WP_Error) True on success, WP_Error object if a field cannot be updated.

Source Source

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

	 *
	 * The type of object is inferred from the passed schema.
	 *
	 * @since 4.7.0
	 *
	 * @param array $schema Schema array.
	 * @return array Modified Schema array.
	 */
	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;
			}

Advertisement

Changelog Changelog

Changelog
Version Description
4.7.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.