WP_REST_Controller::update_additional_fields_for_object( object $data_object, WP_REST_Request $request ): true|WP_Error

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


Parameters

$data_object object Required
Data model like WP_Term or WP_Post.
$request WP_REST_Request Required
Full details about the request.

Top ↑

Return

true|WP_Error True on success, WP_Error object if a field cannot be updated.


Top ↑

Source

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

protected function update_additional_fields_for_object( $data_object, $request ) {
	$additional_fields = $this->get_additional_fields();

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

		// Don't run the update callbacks if the data wasn't passed in the request.
		if ( ! isset( $request[ $field_name ] ) ) {
			continue;
		}

		$result = call_user_func(
			$field_options['update_callback'],
			$request[ $field_name ],
			$data_object,
			$field_name,
			$request,
			$this->get_object_type()
		);

		if ( is_wp_error( $result ) ) {
			return $result;
		}
	}

	return true;
}


Top ↑

Changelog

Changelog
Version Description
4.7.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.