diff options
author | Jonathan Desrosiers <desrosj@git.wordpress.org> | 2019-09-23 16:07:23 +0000 |
---|---|---|
committer | Jonathan Desrosiers <desrosj@git.wordpress.org> | 2019-09-23 16:07:23 +0000 |
commit | 0ff7ebdd97106bd8ff512bb40b0bd5046ed709b4 (patch) | |
tree | d2f6a540d818c9c77ebe76ca9ffec2b35394c878 /src | |
parent | 3363eaa22d1122d73554aea77dbc2cde3b9102ea (diff) | |
download | wordpress-0ff7ebdd97106bd8ff512bb40b0bd5046ed709b4.tar.gz wordpress-0ff7ebdd97106bd8ff512bb40b0bd5046ed709b4.zip |
Docs: Improve documentation for the `supports` argument in `register_post_type()`/`add_post_type_support()`.
Follow up of [46160].
Fixes #40413.
git-svn-id: https://develop.svn.wordpress.org/trunk@46246 602fd350-edb4-49c9-b593-d223f7449a82
Diffstat (limited to 'src')
-rw-r--r-- | src/wp-includes/post.php | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/src/wp-includes/post.php b/src/wp-includes/post.php index 491fc666a4..2043f932ed 100644 --- a/src/wp-includes/post.php +++ b/src/wp-includes/post.php @@ -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.7.0 Introduced `show_in_rest`, `rest_base` and `rest_controller_class` * 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. * * @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'. * Additionally, the 'revisions' feature dictates whether the post type * will store revisions, and the 'comments' feature dictates whether the - * comments count will show on the edit screen. Defaults is an array - * containing 'title' and 'editor'. + * comments count will show on the edit screen. A feature can also be + * 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 * edit form. Do remove_meta_box() and add_meta_box() calls in the * callback. Default null. @@ -1801,6 +1805,9 @@ function _add_post_type_submenus() { * store revisions, and the 'comments' feature dictates whether the comments * 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: * * add_post_type_support( 'my_post_type', 'comments' ); |