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

Timestamp:

12/06/2013 07:17:35 PM (12 years ago)

Author:

DrewAPicture

Message:

Inline documentation fixes for hooks and functions introduced in 3.8.0.

File:

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

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

@@ -312 +312 @@
  * @since 3.8.0
  *
- * @param string $error_msg Error message.
+ * @param string $error_msg Optional. Error message. Default false.
  */
 function wp_dashboard_quick_press( $error_msg = false ) {
@@ -546 +546 @@
  * @since 3.8.0
  *
- * @param array $args
+ * @param array $args {
+ *     An array of query and display arguments.
+ *
+ *     @type int    $display Number of posts to display.
+ *     @type int    $max     Maximum number of posts to query.
+ *     @type string $status  Post status.
+ *     @type string $order   Designates ascending ('ASC') or descending ('DESC') order.
+ *     @type string $title   Section title.
+ *     @type string $id      The container id.
+ * }
+ * @return bool False if no posts were found. True otherwise.
  */
 function wp_dashboard_recent_posts( $args ) {
@@ -618 +628 @@
  * @since 3.8.0
  *
- * @param int $total_items
+ * @param int $total_items Optional. Number of comments to query. Default 5.
+ * @return bool False if no comments were found. True otherwise.
  */
 function wp_dashboard_recent_comments( $total_items = 5 ) {
@@ -844 +855 @@
  *
  * @since 3.8.0
+ *
+ * @param string $widget_id Widget ID.
+ * @param array  $feeds     Array of RSS feeds.
  */
 function wp_dashboard_primary_output( $widget_id, $feeds ) {