Changeset 45786

Timestamp:

08/13/2019 01:51:00 AM (6 years ago)

Author:

kadamwhite

Message:

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

Fixes #47866.

File:

• trunk/src/wp-includes/meta.php (modified) (1 diff)

trunk/src/wp-includes/meta.php

@@ -1130 +1130 @@
  *     @type string $sanitize_callback A function or method to call when sanitizing `$meta_key` data.
  *     @type string $auth_callback     Optional. A function or method to call when performing edit_post_meta, add_post_meta, and delete_post_meta capability checks.
- *     @type bool   $show_in_rest      Whether data associated with this meta key can be considered public.
+ *     @type bool   $show_in_rest      Whether data associated with this meta key can be considered public and
+ *                                     should be accessible via the REST API. A custom post type must also declare
+ *                                     support for custom fields for registered meta to be accessible via REST.
  * }
  * @param string|array $deprecated Deprecated. Use `$args` instead.