diff --git a/src/wp-admin/includes/class-wp-upgrader.php b/src/wp-admin/includes/class-wp-upgrader.php index 544c641520..d88fc7de7b 100644 --- a/src/wp-admin/includes/class-wp-upgrader.php +++ b/src/wp-admin/includes/class-wp-upgrader.php @@ -2036,7 +2036,7 @@ class WP_Automatic_Updater { * * @since 3.8.0 * - * @param array $update_results The results of all updates attempted + * @param array $update_results The results of all attempted updates. */ do_action( 'automatic_updates_complete', $this->update_results ); } @@ -2446,13 +2446,14 @@ Thanks! -- The WordPress Team" ); * @param array $email { * Array of email arguments that will be passed to wp_mail(). * - * @type string $to The email recipient. An array of emails can be returned, as handled by wp_mail(). - * @type string $subject The email's subject. - * @type string $body The email message body. - * @type string $headers Any email headers, defaults to no headers. + * @type string $to The email recipient. An array of emails can be returned, + * as handled by wp_mail(). + * @type string $subject Email subject. + * @type string $body Email message body. + * @type string $headers Any email headers. Default empty. * } - * @param int $failures The number of failures encountered while upgrading - * @param mixed $results The results of all updates attempted + * @param int $failures The number of failures encountered while upgrading. + * @param mixed $results The results of all attempted updates. */ $email = apply_filters( 'automatic_updates_debug_email', $email, $failures, $this->update_results ); diff --git a/src/wp-admin/includes/dashboard.php b/src/wp-admin/includes/dashboard.php index 510f935dd7..773ec5f8fa 100644 --- a/src/wp-admin/includes/dashboard.php +++ b/src/wp-admin/includes/dashboard.php @@ -311,7 +311,7 @@ function wp_network_dashboard_right_now() { * * @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 ) { global $post_ID; @@ -545,7 +545,17 @@ function wp_dashboard_site_activity() { * * @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 ) { $query_args = array( @@ -617,7 +627,8 @@ function wp_dashboard_recent_posts( $args ) { * * @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 ) { global $wpdb; @@ -843,6 +854,9 @@ function wp_dashboard_primary() { * Display the WordPress news feeds. * * @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 ) { foreach( $feeds as $type => $args ) { diff --git a/src/wp-admin/includes/template.php b/src/wp-admin/includes/template.php index 9ff2e0cd5b..076638262a 100644 --- a/src/wp-admin/includes/template.php +++ b/src/wp-admin/includes/template.php @@ -1976,9 +1976,13 @@ function _local_storage_notice() { * * @since 3.8.0 * @param array $args { - * @type int $rating The Rating to display, Expressed in a 0.5 rating increment, or a percentage. - * @type string $type The format that the $rating is in. Valid values are 'rating' (default), or, 'percent'. - * @type int $number The number of ratings which makes up this rating. + * Optional. Array of star ratings arguments. + * + * @type int $rating The rating to display, expressed in either a 0.5 rating increment, + * or percentage. Default 0. + * @type string $type Format that the $rating is in. Valid values are 'rating' (default), + * or, 'percent'. Default 'rating'. + * @type int $number The number of ratings that makes up this rating. Default 0. * } */ function wp_star_rating( $args = array() ) { diff --git a/src/wp-admin/includes/theme.php b/src/wp-admin/includes/theme.php index 9ed912c9ec..a3766c5b32 100644 --- a/src/wp-admin/includes/theme.php +++ b/src/wp-admin/includes/theme.php @@ -113,14 +113,14 @@ function theme_update_available( $theme ) { } /** - * Retrieve the update link if there is an update for a theme available. + * Retrieve the update link if there is a theme update available. * - * Will return a link, if there is an update available. + * Will return a link if there is an update available. * * @since 3.8.0 * - * @param object $theme Theme data object. - * @return string|bool HTML for the update link, or False if no valid info was passed. + * @param WP_Theme $theme WP_Theme object. + * @return string|bool HTML for the update link, or false if invalid info was passed. */ function get_theme_update_available( $theme ) { static $themes_update;