WordPress.org

Make WordPress Core

Opened 2 months ago

Closed 2 months ago

Last modified 2 months ago

#47866 closed defect (bug) (fixed)

Document that register_meta's show_in_rest for Custom Post Types requires custom-fields support

Reported by: kadamwhite Owned by: kadamwhite
Milestone: 5.3 Priority: normal
Severity: normal Version: 4.9.8
Component: REST API Keywords: commit
Focuses: docs Cc:
PR Number:

Description

As noted previously in #40408 and captured in a REST API handbook ticket, a custom post type must include custom-fields in its supports array or the meta key will not appear in REST API responses even if that meta is properly registered using register_meta.

This is true for both register_meta and the derivative register_post_meta method, as in the below rough example:

<?php
register_post_type( 'book', array(
    'public'       => true,
    'show_in_rest' => true,
    'supports'     => array( 'title', 'editor' ),
) );
register_post_meta( 'book', 'awards', array(
    'show_in_rest' => true,
    'single'       => true,
    'type'         => 'integer',
) );

The meta key will be missing from the REST API responses for the book post type in this example because custom-fields is not included in the supports array.
As meta over REST becomes more important to the block editor and complex plugins, I propose we expand the documentation of the show_in_rest argument for register_meta to highlight this caveat.

Attachments (1)

docs-change.diff (1.1 KB) - added by kadamwhite 2 months ago.
Proposed documentation adjustment for show_in_rest field

Download all attachments as: .zip

Change History (5)

@kadamwhite
2 months ago

Proposed documentation adjustment for show_in_rest field

This ticket was mentioned in Slack in #docs by kadamwhite. View the logs.


2 months ago

#2 @netweb
2 months ago

  • Keywords commit added

#3 @kadamwhite
2 months ago

  • Owner set to kadamwhite
  • Resolution set to fixed
  • Status changed from new to closed

In 45786:

Docs: Clarify custom-fields support requirement for viewing custom post meta in REST API.

Fixes #47866.

#4 @leogermani
2 months ago

Great, I had to find out it myself couple of days ago and it wasn't straight forward.

As a suggestion, maybe it could indicate more directly what needs to be present. Something like: "... declare support to custom post types by having 'custom-fields' in its 'supports' array. (@see register_post_type)"

Note: See TracTickets for help on using tickets.