Changeset 46246

Timestamp:

09/23/2019 04:07:23 PM (5 years ago)

Author:

desrosj

Message:

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

Follow up of [46160].

Fixes #40413.

File:

• trunk/src/wp-includes/post.php (modified) (3 diffs)

trunk/src/wp-includes/post.php

@@ -1273 +1273 @@
  * @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.
  *
@@ -1344 +1345 @@
  *                                              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
@@ -1801 +1805 @@
  * 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: