WP_REST_Controller::update_additional_fields_for_object() WordPress Method
The WP_REST_Controller::update_additional_fields_for_object() is a method used to update additional fields for a registered REST API object. This is useful for adding extra data to an object that is not part of the standard WordPress schema. For example, if you have a custom post type with additional meta fields, you can use this method to update those fields when a post is updated via the REST API.
WP_REST_Controller::update_additional_fields_for_object( object $object, WP_REST_Request $request ) #
Updates the values of additional fields added to a data object.
Parameters
- $object
- $request
(WP_REST_Request)(Required)Full details about the request.
Return
(true|WP_Error) True on success, WP_Error object if a field cannot be updated.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-controller.php
protected function update_additional_fields_for_object( $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 ], $object, $field_name, $request, $this->get_object_type() );
if ( is_wp_error( $result ) ) {
return $result;
}
}
return true;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |