Changeset 46196

Timestamp:

09/20/2019 01:04:50 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Clarify that $show_in_rest parameter of register_post_type() and register_taxonomy() should be enabled for the post type or taxonomy to be available in the block editor.

Props ramon-fincken.
Fixes #48084.

Location:

trunk/src/wp-includes

Files:

• post.php (modified) (1 diff)
• taxonomy.php (modified) (1 diff)

trunk/src/wp-includes/post.php

@@ -1314 +1314 @@
  *                                              Default is value of $show_ui.
  *     @type bool        $show_in_nav_menus     Makes this post type available for selection in navigation menus.
- *                                              Default is value $public.
+ *                                              Default is value of $public.
  *     @type bool        $show_in_admin_bar     Makes this post type available via the admin bar. Default is value
  *                                              of $show_in_menu.
- *     @type bool        $show_in_rest          Whether to add the post type route in the REST API 'wp/v2' namespace.
+ *     @type bool        $show_in_rest          Whether to include the post type in the REST API. Set this to true
+ *                                              for the post type to be available in the block editor.
  *     @type string      $rest_base             To change the base url of REST API route. Default is $post_type.
  *     @type string      $rest_controller_class REST API Controller class name. Default is 'WP_REST_Posts_Controller'.

trunk/src/wp-includes/taxonomy.php

@@ -364 +364 @@
  *     @type bool          $show_in_nav_menus     Makes this taxonomy available for selection in navigation menus. If not
  *                                                set, the default is inherited from `$public` (default true).
- *     @type bool          $show_in_rest          Whether to include the taxonomy in the REST API.
+ *     @type bool          $show_in_rest          Whether to include the taxonomy in the REST API. Set this to true
+ *                                                for the taxonomy to be available in the block editor.
  *     @type string        $rest_base             To change the base url of REST API route. Default is $taxonomy.
  *     @type string        $rest_controller_class REST API Controller class name. Default is 'WP_REST_Terms_Controller'.