Docs: Add missing REST API-related args to `register_post_type()` and `register_taxonomy()`.
These functions now accept the `show_in_rest`, `rest_base`, and `rest_controller_class` args. Merges [39462] to the 4.7 branch. Props ketuchetan, rahulsprajapati. Fixes #39023. Built from https://develop.svn.wordpress.org/branches/4.7@39463 git-svn-id: http://core.svn.wordpress.org/branches/4.7@39403 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Gary Pendergast
parent
250f92a59e
commit
dae13be262
|
|
@ -985,6 +985,8 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' )
|
||||||
* @since 4.4.0 The `show_ui` argument is now enforced on the post type listing
|
* @since 4.4.0 The `show_ui` argument is now enforced on the post type listing
|
||||||
* screen and post editing screen.
|
* screen and post editing screen.
|
||||||
* @since 4.6.0 Post type object returned is now an instance of WP_Post_Type.
|
* @since 4.6.0 Post type object returned is now an instance of WP_Post_Type.
|
||||||
|
* @since 4.7.0 Introduced `show_in_rest`, 'rest_base' and 'rest_controller_class'
|
||||||
|
* arguments to register the post type in REST API.
|
||||||
*
|
*
|
||||||
* @global array $wp_post_types List of post types.
|
* @global array $wp_post_types List of post types.
|
||||||
*
|
*
|
||||||
|
|
@ -994,76 +996,79 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' )
|
||||||
* @param array|string $args {
|
* @param array|string $args {
|
||||||
* Array or string of arguments for registering a post type.
|
* Array or string of arguments for registering a post type.
|
||||||
*
|
*
|
||||||
* @type string $label Name of the post type shown in the menu. Usually plural.
|
* @type string $label Name of the post type shown in the menu. Usually plural.
|
||||||
* Default is value of $labels['name'].
|
* Default is value of $labels['name'].
|
||||||
* @type array $labels An array of labels for this post type. If not set, post
|
* @type array $labels An array of labels for this post type. If not set, post
|
||||||
* labels are inherited for non-hierarchical types and page
|
* labels are inherited for non-hierarchical types and page
|
||||||
* labels for hierarchical ones. See get_post_type_labels() for a full
|
* labels for hierarchical ones. See get_post_type_labels() for a full
|
||||||
* list of supported labels.
|
* list of supported labels.
|
||||||
* @type string $description A short descriptive summary of what the post type is.
|
* @type string $description A short descriptive summary of what the post type is.
|
||||||
* Default empty.
|
* Default empty.
|
||||||
* @type bool $public Whether a post type is intended for use publicly either via
|
* @type bool $public Whether a post type is intended for use publicly either via
|
||||||
* the admin interface or by front-end users. While the default
|
* the admin interface or by front-end users. While the default
|
||||||
* settings of $exclude_from_search, $publicly_queryable, $show_ui,
|
* settings of $exclude_from_search, $publicly_queryable, $show_ui,
|
||||||
* and $show_in_nav_menus are inherited from public, each does not
|
* and $show_in_nav_menus are inherited from public, each does not
|
||||||
* rely on this relationship and controls a very specific intention.
|
* rely on this relationship and controls a very specific intention.
|
||||||
* Default false.
|
* Default false.
|
||||||
* @type bool $hierarchical Whether the post type is hierarchical (e.g. page). Default false.
|
* @type bool $hierarchical Whether the post type is hierarchical (e.g. page). Default false.
|
||||||
* @type bool $exclude_from_search Whether to exclude posts with this post type from front end search
|
* @type bool $exclude_from_search Whether to exclude posts with this post type from front end search
|
||||||
* results. Default is the opposite value of $public.
|
* results. Default is the opposite value of $public.
|
||||||
* @type bool $publicly_queryable Whether queries can be performed on the front end for the post type
|
* @type bool $publicly_queryable Whether queries can be performed on the front end for the post type
|
||||||
* as part of parse_request(). Endpoints would include:
|
* as part of parse_request(). Endpoints would include:
|
||||||
* * ?post_type={post_type_key}
|
* * ?post_type={post_type_key}
|
||||||
* * ?{post_type_key}={single_post_slug}
|
* * ?{post_type_key}={single_post_slug}
|
||||||
* * ?{post_type_query_var}={single_post_slug}
|
* * ?{post_type_query_var}={single_post_slug}
|
||||||
* If not set, the default is inherited from $public.
|
* If not set, the default is inherited from $public.
|
||||||
* @type bool $show_ui Whether to generate and allow a UI for managing this post type in the
|
* @type bool $show_ui Whether to generate and allow a UI for managing this post type in the
|
||||||
* admin. Default is value of $public.
|
* admin. Default is value of $public.
|
||||||
* @type bool $show_in_menu Where to show the post type in the admin menu. To work, $show_ui
|
* @type bool $show_in_menu Where to show the post type in the admin menu. To work, $show_ui
|
||||||
* must be true. If true, the post type is shown in its own top level
|
* must be true. If true, the post type is shown in its own top level
|
||||||
* menu. If false, no menu is shown. If a string of an existing top
|
* menu. If false, no menu is shown. If a string of an existing top
|
||||||
* level menu (eg. 'tools.php' or 'edit.php?post_type=page'), the post
|
* level menu (eg. 'tools.php' or 'edit.php?post_type=page'), the post
|
||||||
* type will be placed as a sub-menu of that.
|
* type will be placed as a sub-menu of that.
|
||||||
* Default is value of $show_ui.
|
* Default is value of $show_ui.
|
||||||
* @type bool $show_in_nav_menus Makes this post type available for selection in navigation menus.
|
* @type bool $show_in_nav_menus Makes this post type available for selection in navigation menus.
|
||||||
* Default is value $public.
|
* Default is value $public.
|
||||||
* @type bool $show_in_admin_bar Makes this post type available via the admin bar. Default is value
|
* @type bool $show_in_admin_bar Makes this post type available via the admin bar. Default is value
|
||||||
* of $show_in_menu.
|
* of $show_in_menu.
|
||||||
* @type int $menu_position The position in the menu order the post type should appear. To work,
|
* @type bool $show_in_rest Whether to add the post type route in the REST API 'wp/v2' namespace.
|
||||||
* $show_in_menu must be true. Default null (at the bottom).
|
* @type string $rest_base To change the base url of REST API route. Default is $post_type.
|
||||||
* @type string $menu_icon The url to the icon to be used for this menu. Pass a base64-encoded
|
* @type string $rest_controller_class REST API Controller class name. Default is 'WP_REST_Posts_Controller'.
|
||||||
* SVG using a data URI, which will be colored to match the color scheme
|
* @type int $menu_position The position in the menu order the post type should appear. To work,
|
||||||
* -- this should begin with 'data:image/svg+xml;base64,'. Pass the name
|
* $show_in_menu must be true. Default null (at the bottom).
|
||||||
* of a Dashicons helper class to use a font icon, e.g.
|
* @type string $menu_icon The url to the icon to be used for this menu. Pass a base64-encoded
|
||||||
* 'dashicons-chart-pie'. Pass 'none' to leave div.wp-menu-image empty
|
* SVG using a data URI, which will be colored to match the color scheme
|
||||||
* so an icon can be added via CSS. Defaults to use the posts icon.
|
* -- this should begin with 'data:image/svg+xml;base64,'. Pass the name
|
||||||
* @type string $capability_type The string to use to build the read, edit, and delete capabilities.
|
* of a Dashicons helper class to use a font icon, e.g.
|
||||||
* May be passed as an array to allow for alternative plurals when using
|
* 'dashicons-chart-pie'. Pass 'none' to leave div.wp-menu-image empty
|
||||||
* this argument as a base to construct the capabilities, e.g.
|
* so an icon can be added via CSS. Defaults to use the posts icon.
|
||||||
* array('story', 'stories'). Default 'post'.
|
* @type string $capability_type The string to use to build the read, edit, and delete capabilities.
|
||||||
* @type array $capabilities Array of capabilities for this post type. $capability_type is used
|
* May be passed as an array to allow for alternative plurals when using
|
||||||
* as a base to construct capabilities by default.
|
* this argument as a base to construct the capabilities, e.g.
|
||||||
* See get_post_type_capabilities().
|
* array('story', 'stories'). Default 'post'.
|
||||||
* @type bool $map_meta_cap Whether to use the internal default meta capability handling.
|
* @type array $capabilities Array of capabilities for this post type. $capability_type is used
|
||||||
* Default false.
|
* as a base to construct capabilities by default.
|
||||||
* @type array $supports Core feature(s) the post type supports. Serves as an alias for calling
|
* See get_post_type_capabilities().
|
||||||
* add_post_type_support() directly. Core features include 'title',
|
* @type bool $map_meta_cap Whether to use the internal default meta capability handling.
|
||||||
* 'editor', 'comments', 'revisions', 'trackbacks', 'author', 'excerpt',
|
* Default false.
|
||||||
* 'page-attributes', 'thumbnail', 'custom-fields', and 'post-formats'.
|
* @type array $supports Core feature(s) the post type supports. Serves as an alias for calling
|
||||||
* Additionally, the 'revisions' feature dictates whether the post type
|
* add_post_type_support() directly. Core features include 'title',
|
||||||
* will store revisions, and the 'comments' feature dictates whether the
|
* 'editor', 'comments', 'revisions', 'trackbacks', 'author', 'excerpt',
|
||||||
* comments count will show on the edit screen. Defaults is an array
|
* 'page-attributes', 'thumbnail', 'custom-fields', and 'post-formats'.
|
||||||
* containing 'title' and 'editor'.
|
* Additionally, the 'revisions' feature dictates whether the post type
|
||||||
* @type callable $register_meta_box_cb Provide a callback function that sets up the meta boxes for the
|
* will store revisions, and the 'comments' feature dictates whether the
|
||||||
* edit form. Do remove_meta_box() and add_meta_box() calls in the
|
* comments count will show on the edit screen. Defaults is an array
|
||||||
* callback. Default null.
|
* containing 'title' and 'editor'.
|
||||||
* @type array $taxonomies An array of taxonomy identifiers that will be registered for the
|
* @type callable $register_meta_box_cb Provide a callback function that sets up the meta boxes for the
|
||||||
* post type. Taxonomies can be registered later with register_taxonomy()
|
* edit form. Do remove_meta_box() and add_meta_box() calls in the
|
||||||
* or register_taxonomy_for_object_type().
|
* callback. Default null.
|
||||||
* Default empty array.
|
* @type array $taxonomies An array of taxonomy identifiers that will be registered for the
|
||||||
* @type bool|string $has_archive Whether there should be post type archives, or if a string, the
|
* post type. Taxonomies can be registered later with register_taxonomy()
|
||||||
* archive slug to use. Will generate the proper rewrite rules if
|
* or register_taxonomy_for_object_type().
|
||||||
* $rewrite is enabled. Default false.
|
* Default empty array.
|
||||||
|
* @type bool|string $has_archive Whether there should be post type archives, or if a string, the
|
||||||
|
* archive slug to use. Will generate the proper rewrite rules if
|
||||||
|
* $rewrite is enabled. Default false.
|
||||||
* @type bool|array $rewrite {
|
* @type bool|array $rewrite {
|
||||||
* Triggers the handling of rewrites for this post type. To prevent rewrite, set to false.
|
* Triggers the handling of rewrites for this post type. To prevent rewrite, set to false.
|
||||||
* Defaults to true, using $post_type as slug. To specify rewrite rules, an array can be
|
* Defaults to true, using $post_type as slug. To specify rewrite rules, an array can be
|
||||||
|
|
@ -1079,21 +1084,21 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' )
|
||||||
* inherits from $permalink_epmask. If not specified and permalink_epmask
|
* inherits from $permalink_epmask. If not specified and permalink_epmask
|
||||||
* is not set, defaults to EP_PERMALINK.
|
* is not set, defaults to EP_PERMALINK.
|
||||||
* }
|
* }
|
||||||
* @type string|bool $query_var Sets the query_var key for this post type. Defaults to $post_type
|
* @type string|bool $query_var Sets the query_var key for this post type. Defaults to $post_type
|
||||||
* key. If false, a post type cannot be loaded at
|
* key. If false, a post type cannot be loaded at
|
||||||
* ?{query_var}={post_slug}. If specified as a string, the query
|
* ?{query_var}={post_slug}. If specified as a string, the query
|
||||||
* ?{query_var_string}={post_slug} will be valid.
|
* ?{query_var_string}={post_slug} will be valid.
|
||||||
* @type bool $can_export Whether to allow this post type to be exported. Default true.
|
* @type bool $can_export Whether to allow this post type to be exported. Default true.
|
||||||
* @type bool $delete_with_user Whether to delete posts of this type when deleting a user. If true,
|
* @type bool $delete_with_user Whether to delete posts of this type when deleting a user. If true,
|
||||||
* posts of this type belonging to the user will be moved to trash
|
* posts of this type belonging to the user will be moved to trash
|
||||||
* when then user is deleted. If false, posts of this type belonging
|
* when then user is deleted. If false, posts of this type belonging
|
||||||
* to the user will *not* be trashed or deleted. If not set (the default),
|
* to the user will *not* be trashed or deleted. If not set (the default),
|
||||||
* posts are trashed if post_type_supports('author'). Otherwise posts
|
* posts are trashed if post_type_supports('author'). Otherwise posts
|
||||||
* are not trashed or deleted. Default null.
|
* are not trashed or deleted. Default null.
|
||||||
* @type bool $_builtin FOR INTERNAL USE ONLY! True if this post type is a native or
|
* @type bool $_builtin FOR INTERNAL USE ONLY! True if this post type is a native or
|
||||||
* "built-in" post_type. Default false.
|
* "built-in" post_type. Default false.
|
||||||
* @type string $_edit_link FOR INTERNAL USE ONLY! URL segment to use for edit link of
|
* @type string $_edit_link FOR INTERNAL USE ONLY! URL segment to use for edit link of
|
||||||
* this post type. Default 'post.php?post=%d'.
|
* this post type. Default 'post.php?post=%d'.
|
||||||
* }
|
* }
|
||||||
* @return WP_Post_Type|WP_Error The registered post type object, or an error object.
|
* @return WP_Post_Type|WP_Error The registered post type object, or an error object.
|
||||||
*/
|
*/
|
||||||
|
|
|
||||||
|
|
@ -294,6 +294,8 @@ function is_taxonomy_hierarchical($taxonomy) {
|
||||||
* @since 4.4.0 The `show_ui` argument is now enforced on the term editing screen.
|
* @since 4.4.0 The `show_ui` argument is now enforced on the term editing screen.
|
||||||
* @since 4.4.0 The `public` argument now controls whether the taxonomy can be queried on the front end.
|
* @since 4.4.0 The `public` argument now controls whether the taxonomy can be queried on the front end.
|
||||||
* @since 4.5.0 Introduced `publicly_queryable` argument.
|
* @since 4.5.0 Introduced `publicly_queryable` argument.
|
||||||
|
* @since 4.7.0 Introduced `show_in_rest`, 'rest_base' and 'rest_controller_class'
|
||||||
|
* arguments to register the Taxonomy in REST API.
|
||||||
*
|
*
|
||||||
* @global array $wp_taxonomies Registered taxonomies.
|
* @global array $wp_taxonomies Registered taxonomies.
|
||||||
*
|
*
|
||||||
|
|
@ -323,6 +325,9 @@ function is_taxonomy_hierarchical($taxonomy) {
|
||||||
* (default true).
|
* (default true).
|
||||||
* @type bool $show_in_nav_menus Makes this taxonomy available for selection in navigation menus. If not
|
* @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).
|
* set, the default is inherited from `$public` (default true).
|
||||||
|
* @type bool $show_in_rest Whether to include the taxonomy in the REST API.
|
||||||
|
* @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'.
|
||||||
* @type bool $show_tagcloud Whether to list the taxonomy in the Tag Cloud Widget controls. If not set,
|
* @type bool $show_tagcloud Whether to list the taxonomy in the Tag Cloud Widget controls. If not set,
|
||||||
* the default is inherited from `$show_ui` (default true).
|
* the default is inherited from `$show_ui` (default true).
|
||||||
* @type bool $show_in_quick_edit Whether to show the taxonomy in the quick/bulk edit panel. It not set,
|
* @type bool $show_in_quick_edit Whether to show the taxonomy in the quick/bulk edit panel. It not set,
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@
|
||||||
*
|
*
|
||||||
* @global string $wp_version
|
* @global string $wp_version
|
||||||
*/
|
*/
|
||||||
$wp_version = '4.7-RC1-39461';
|
$wp_version = '4.7-RC1-39463';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue