1. Skip to note content

   You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

   Contributed by Nate Finch — 2 years ago

   An example to add all of the post meta to a post-meta-fields field:

   add_action( 'rest_api_init', 'create_api_posts_meta_field' );
   
   function create_api_posts_meta_field() {
   
   	// register_rest_field ( 'name-of-post-type', 'name-of-field-to-return', array-of-callbacks-and-schema() )
   	register_rest_field( 'post', 'post-meta-fields', array(
   	       'get_callback'    => 'get_post_meta_for_api',
   	       'schema'          => null,
   	    )
   	);
   }
   
   function get_post_meta_for_api( $object ) {
   	//get the id of the post object array
   	$post_id = $object['id'];
   
   	//return the post meta
    	return get_post_meta( $post_id );
   }

   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.
2. Skip to note content

   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   Contributed by Matt Barrett (corradomatt) — 1 year ago

   GET callbacks accept up to 4 arguments in order…

   • $post – (object) Post or custom post type object of the request.
   • $attr – (string) Rest field/attr string identifier from the second parameter of your register_rest_field() declaration.
   • $request – (object) Full request payload – as a WP_REST_Request object
   • $object_type – (string) The object type which the field is registered against. Typically first parameter of your 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.
3. Skip to note content

   You must log in to vote on the helpfulness of this noteVote results for this note: -2You must log in to vote on the helpfulness of this note

   Contributed by systemosa — 2 years ago

   // assume there custom post_type named events 
   add_action( 'rest_api_init', function() {
       register_rest_field( 'events', 'event_date', array(
   
           'get_callback' => function( $comment_arr ) {
               $comment_obj = get_field('event_date', $comment_arr['id'] );
               return $comment_obj;
           },
   
           'update_callback' => function( $karma, $comment_obj ) {
               update_field('event_date', $karma, $comment_arr['id'] );
               return true;
           },
   
           'schema' => array(
               'event_date' => __( 'event_date' ),
               'type'        => 'text'
           ),
   
       ));
   
   });
   

   Expand full source codeCollapse full source code

Have a note or feedback to contribute?