Changeset 42875 for trunk/src/wp-admin/includes/template.php

Timestamp:

03/25/2018 06:09:56 PM (7 years ago)

Author:

johnbillion

Message:

Docs: Document more parameters and properties using typed array notation.

See #41756

File:

• trunk/src/wp-admin/includes/template.php (modified) (4 diffs)

trunk/src/wp-admin/includes/template.php

@@ -30 +30 @@
  * @param int    $descendants_and_self Optional. ID of the category to output along with its descendants.
  *                                     Default 0.
- * @param array  $selected_cats        Optional. List of categories to mark as checked. Default false.
- * @param array  $popular_cats         Optional. List of categories to receive the "popular-category" class.
+ * @param int[]  $selected_cats        Optional. Array of category IDs to mark as checked. Default false.
+ * @param int[]  $popular_cats         Optional. Array of category IDs to receive the "popular-category" class.
  *                                     Default false.
  * @param object $walker               Optional. Walker object to use to build the output.
@@ -65 +65 @@
  *     @type int    $descendants_and_self ID of the category to output along with its descendants.
  *                                        Default 0.
- *     @type array  $selected_cats        List of categories to mark as checked. Default false.
- *     @type array  $popular_cats         List of categories to receive the "popular-category" class.
+ *     @type int[]  $selected_cats        Array of category IDs to mark as checked. Default false.
+ *     @type int[]  $popular_cats         Array of category IDs to receive the "popular-category" class.
  *                                        Default false.
  *     @type object $walker               Walker object to use to build the output.
@@ -1898 +1898 @@
      * @since 3.6.0 Added the `$post` parameter.
      *
-     * @param array   $post_states An array of post display states.
-     * @param WP_Post $post        The current post object.
+     * @param string[] $post_states An array of post display states.
+     * @param WP_Post  $post        The current post object.
      */
     $post_states = apply_filters( 'display_post_states', $post_states, $post );
@@ -1974 +1974 @@
      * @since 4.8.0 Added the `$post` parameter.
      *
-     * @param array   $media_states An array of media states. Default 'Header Image',
-     *                              'Background Image', 'Site Icon', 'Logo'.
-     * @param WP_Post $post         The current attachment object.
+     * @param string[] $media_states An array of media states. Default 'Header Image',
+     *                               'Background Image', 'Site Icon', 'Logo'.
+     * @param WP_Post  $post         The current attachment object.
      */
     $media_states = apply_filters( 'display_media_states', $media_states, $post );