sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Improve documentation for the supports argument in register_post_type()/add_post_type_support().

Browse Source 
Follow up of [46160].

Fixes #40413.

git-svn-id: https://develop.svn.wordpress.org/trunk@46246 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Jonathan Desrosiers 2019-09-23 16:07:23 +00:00
parent 3363eaa22d
commit 0ff7ebdd97
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/wp-includes/post.php
View File

@ -1272,7 +1272,8 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' )
* @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` * @since 4.7.0 Introduced `show_in_rest`, `rest_base` and `rest_controller_class`
* arguments to register the post type in REST API. * arguments to register the post type in REST API.
* * @since 5.3.0 The `supports` argument will now accept an array of arguments for a feature.
* .
* @global array $wp_post_types List of post types. * @global array $wp_post_types List of post types.
* *
* @param string $post_type Post type key. Must not exceed 20 characters and may * @param string $post_type Post type key. Must not exceed 20 characters and may
@ -1343,8 +1344,11 @@ function get_post_types( $args = array(), $output = 'names', $operator = 'and' )
* 'page-attributes', 'thumbnail', 'custom-fields', and 'post-formats'. * 'page-attributes', 'thumbnail', 'custom-fields', and 'post-formats'.
* Additionally, the 'revisions' feature dictates whether the post type * Additionally, the 'revisions' feature dictates whether the post type
* will store revisions, and the 'comments' feature dictates whether the * will store revisions, and the 'comments' feature dictates whether the
* comments count will show on the edit screen. Defaults is an array * comments count will show on the edit screen. A feature can also be
* containing 'title' and 'editor'. * specified as an array of arguments to provide additional information
* about supporting that feature. Example: `array( 'my_feature', array(
* 'field' => 'value' ) )`. Default is an array containing 'title' and
* 'editor'.
* @type callable $register_meta_box_cb Provide a callback function that sets up the meta boxes for the * @type callable $register_meta_box_cb Provide a callback function that sets up the meta boxes for the
* edit form. Do remove_meta_box() and add_meta_box() calls in the * edit form. Do remove_meta_box() and add_meta_box() calls in the
* callback. Default null. * callback. Default null.
@ -1801,6 +1805,9 @@ function _add_post_type_submenus() {
* store revisions, and the 'comments' feature dictates whether the comments * store revisions, and the 'comments' feature dictates whether the comments
* count will show on the edit screen. * count will show on the edit screen.
* *
* A third, optional parameter can also be passed along with a feature to provide
* additional information about supporting that feature.
*
* Example usage: * Example usage:
* *
* add_post_type_support( 'my_post_type', 'comments' ); * add_post_type_support( 'my_post_type', 'comments' );