From 2742c7e8affe8a36026bf892b968d78872250ee4 Mon Sep 17 00:00:00 2001 From: desrosj Date: Mon, 23 Sep 2019 16:08:57 +0000 Subject: [PATCH] Docs: Improve documentation for the `supports` argument in `register_post_type()`/`add_post_type_support()`. Follow up of [46160]. Fixes #40413. Built from https://develop.svn.wordpress.org/trunk@46246 git-svn-id: http://core.svn.wordpress.org/trunk@46058 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/post.php | 13 ++++++++++--- wp-includes/version.php | 2 +- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/wp-includes/post.php b/wp-includes/post.php index 491fc666a4..2043f932ed 100644 --- a/wp-includes/post.php +++ b/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' ); diff --git a/wp-includes/version.php b/wp-includes/version.php index 068e093fcf..ffe69c6493 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -13,7 +13,7 @@ * * @global string $wp_version */ -$wp_version = '5.3-alpha-46245'; +$wp_version = '5.3-alpha-46246'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.