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

Timestamp:

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

Author:

johnbillion

Message:

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

See #41756

File:

• trunk/src/wp-admin/includes/dashboard.php (modified) (6 diffs)

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

@@ -80 +80 @@
                  * @since 3.1.0
                  *
-                 * @param array $dashboard_widgets An array of dashboard widgets.
+                 * @param string[] $dashboard_widgets An array of dashboard widget IDs.
                  */
                 $dashboard_widgets = apply_filters( 'wp_network_dashboard_widgets', array() );
@@ -97 +97 @@
                  * @since 3.1.0
                  *
-                 * @param array $dashboard_widgets An array of dashboard widgets.
+                 * @param string[] $dashboard_widgets An array of dashboard widget IDs.
                  */
                 $dashboard_widgets = apply_filters( 'wp_user_dashboard_widgets', array() );
@@ -114 +114 @@
                  * @since 2.5.0
                  *
-                 * @param array $dashboard_widgets An array of dashboard widgets.
+                 * @param string[] $dashboard_widgets An array of dashboard widget IDs.
                  */
                 $dashboard_widgets = apply_filters( 'wp_dashboard_widgets', array() );
@@ -315 +315 @@
          * @since 3.8.0
          *
-         * @param array $items Array of extra 'At a Glance' widget items.
+         * @param string[] $items Array of extra 'At a Glance' widget items.
          */
         $elements = apply_filters( 'dashboard_glance_items', array() );
@@ -556 +556 @@
  * @since 2.7.0
  *
- * @param array $drafts
+ * @param WP_Post[] $drafts Optional. Array of posts to display. Default false.
  */
 function wp_dashboard_recent_drafts( $drafts = false ) {
@@ -672 +672 @@
                  * @since 2.6.0
                  *
-                 * @param array      $actions An array of comment actions. Default actions include:
+                 * @param string[]   $actions An array of comment actions. Default actions include:
                  *                            'Approve', 'Unapprove', 'Edit', 'Reply', 'Spam',
                  *                            'Delete', and 'Trash'.