WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Inline documentation fixes for hooks and functions introduced in 3.8.0. 

Built from https://develop.svn.wordpress.org/trunk@26736


git-svn-id: http://core.svn.wordpress.org/trunk@26625 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2013-12-06 19:18:11 +00:00
parent c74da427f4
commit 7bf5470bab
4 changed files with 36 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
wp-admin/includes/class-wp-upgrader.php
View File

@ -2036,7 +2036,7 @@ class WP_Automatic_Updater {
* *
* @since 3.8.0 * @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 ); do_action( 'automatic_updates_complete', $this->update_results );
} }
@ -2446,13 +2446,14 @@ Thanks! -- The WordPress Team" );
* @param array $email { * @param array $email {
* Array of email arguments that will be passed to wp_mail(). * 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 $to The email recipient. An array of emails can be returned,
* @type string $subject The email's subject. * as handled by wp_mail().
* @type string $body The email message body. * @type string $subject Email subject.
* @type string $headers Any email headers, defaults to no headers. * @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 int $failures The number of failures encountered while upgrading.
* @param mixed $results The results of all updates attempted * @param mixed $results The results of all attempted updates.
*/ */
$email = apply_filters( 'automatic_updates_debug_email', $email, $failures, $this->update_results ); $email = apply_filters( 'automatic_updates_debug_email', $email, $failures, $this->update_results );

20
wp-admin/includes/dashboard.php
View File

@ -311,7 +311,7 @@ function wp_network_dashboard_right_now() {
* *
* @since 3.8.0 * @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 ) { function wp_dashboard_quick_press( $error_msg = false ) {
global $post_ID; global $post_ID;
@ -545,7 +545,17 @@ function wp_dashboard_site_activity() {
* *
* @since 3.8.0 * @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 ) { function wp_dashboard_recent_posts( $args ) {
$query_args = array( $query_args = array(
@ -617,7 +627,8 @@ function wp_dashboard_recent_posts( $args ) {
* *
* @since 3.8.0 * @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 ) { function wp_dashboard_recent_comments( $total_items = 5 ) {
global $wpdb; global $wpdb;
@ -843,6 +854,9 @@ function wp_dashboard_primary() {
* Display the WordPress news feeds. * Display the WordPress news feeds.
* *
* @since 3.8.0 * @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 ) { function wp_dashboard_primary_output( $widget_id, $feeds ) {
foreach( $feeds as $type => $args ) { foreach( $feeds as $type => $args ) {

10
wp-admin/includes/template.php
View File

@ -1976,9 +1976,13 @@ function _local_storage_notice() {
* *
* @since 3.8.0 * @since 3.8.0
* @param array $args { * @param array $args {
* @type int $rating The Rating to display, Expressed in a 0.5 rating increment, or a percentage. * Optional. Array of star ratings arguments.
* @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. * @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() ) { function wp_star_rating( $args = array() ) {

8
wp-admin/includes/theme.php
View File

@ -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 * @since 3.8.0
* *
* @param object $theme Theme data object. * @param WP_Theme $theme WP_Theme object.
* @return string|bool HTML for the update link, or False if no valid info was passed. * @return string|bool HTML for the update link, or false if invalid info was passed.
*/ */
function get_theme_update_available( $theme ) { function get_theme_update_available( $theme ) {
static $themes_update; static $themes_update;