register_rest_field( string|array $object_type, string $attribute, array $args = array() )
Registers a new field on an existing WordPress object type.
Description Description
Parameters Parameters
- $object_type
-
(string|array) (Required) Object(s) the field is being registered to, "post"|"term"|"comment" etc.
- $attribute
-
(string) (Required) The attribute name.
- $args
-
(array) (Optional) An array of arguments used to handle the registered field.
- 'get_callback'
(string|array|null) Optional. The callback function used to retrieve the field value. Default is 'null', the field will not be returned in the response. - 'update_callback'
(string|array|null) Optional. The callback function used to set and update the field value. Default is 'null', the value cannot be set or updated. - 'schema'
(string|array|null) Optional. The callback function used to create the schema for this field. Default is 'null', no schema entry will be returned.
Default value: array()
- 'get_callback'
Source Source
File: wp-includes/rest-api.php
function register_rest_field( $object_type, $attribute, $args = array() ) { $defaults = array( 'get_callback' => null, 'update_callback' => null, 'schema' => null, ); $args = wp_parse_args( $args, $defaults ); global $wp_rest_additional_fields; $object_types = (array) $object_type; foreach ( $object_types as $object_type ) { $wp_rest_additional_fields[ $object_type ][ $attribute ] = $args; } }
Expand full source code Collapse full source code View on Trac
Changelog Changelog
Version | Description |
---|---|
4.7.0 | Introduced. |
User Contributed Notes User Contributed Notes
You must log in before being able to contribute a note or feedback.
An example to add all of the post meta to a
post-meta-fields
field:Expand full source codeCollapse full source code
This can be extended or edited. For example, if you don’t want to include all the post meta, you can filter it, or return only the field you need. The options are limitless, but the callback gives you access to the post object, which exposes the
id
among other parameters, so you can use many different helper functions.GET callbacks accept up to 4 arguments in order…
register_rest_field()
declaration.register_rest_field()
declaration.Post callbacks accept the above arguments but also a 5th argument in the first position which is the value being passed from the POST request to the attribute/field.
Feedback
The order for update callback is not correct (anymore?). As of March 2018, WordPress 4.9.4 the order of arguments in update_callback: $metaValue, $object, $metaKey. — By aepp —
This code works (also with shipped Backbone client) in WordPress 4.9.4:
Expand full source codeCollapse full source code
Custom sql queries can be achieved to get whatever value you want from database. The following queries shows how can we modify rest output to show something from our custom table ‘wp_it_job_details’ which is, of course, inside WordPress database. Put it in your themes/plugins functions.php
Expand full source codeCollapse full source code
Expand full source codeCollapse full source code
Feedback
This update_callback returns an error, since $comment_obj is an instance of \WP_Post. It should be instead $comment_obj->ID. — By aepp —