<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[26736] trunk/src/wp-admin/includes: Inline documentation fixes for hooks and functions introduced in 3.8.0.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/26736">26736</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2013-12-06 19:17:35 +0000 (Fri, 06 Dec 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation fixes for hooks and functions introduced in 3.8.0.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswpupgraderphp">trunk/src/wp-admin/includes/class-wp-upgrader.php</a></li>
<li><a href="#trunksrcwpadminincludesdashboardphp">trunk/src/wp-admin/includes/dashboard.php</a></li>
<li><a href="#trunksrcwpadminincludestemplatephp">trunk/src/wp-admin/includes/template.php</a></li>
<li><a href="#trunksrcwpadminincludesthemephp">trunk/src/wp-admin/includes/theme.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswpupgraderphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/includes/class-wp-upgrader.php (26735 => 26736)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/includes/class-wp-upgrader.php 2013-12-06 19:15:31 UTC (rev 26735)
+++ trunk/src/wp-admin/includes/class-wp-upgrader.php 2013-12-06 19:17:35 UTC (rev 26736)
</span><span class="lines">@@ -2036,7 +2036,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 3.8.0
</span><span class="cx"> *
</span><del>- * @param array $update_results The results of all updates attempted
</del><ins>+ * @param array $update_results The results of all attempted updates.
</ins><span class="cx"> */
</span><span class="cx"> do_action( 'automatic_updates_complete', $this->update_results );
</span><span class="cx"> }
</span><span class="lines">@@ -2446,13 +2446,14 @@
</span><span class="cx"> * @param array $email {
</span><span class="cx"> * Array of email arguments that will be passed to wp_mail().
</span><span class="cx"> *
</span><del>- * @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.
</del><ins>+ * @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.
</ins><span class="cx"> * }
</span><del>- * @param int $failures The number of failures encountered while upgrading
- * @param mixed $results The results of all updates attempted
</del><ins>+ * @param int $failures The number of failures encountered while upgrading.
+ * @param mixed $results The results of all attempted updates.
</ins><span class="cx"> */
</span><span class="cx"> $email = apply_filters( 'automatic_updates_debug_email', $email, $failures, $this->update_results );
</span><span class="cx">
</span></span></pre></div>
<a id="trunksrcwpadminincludesdashboardphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/includes/dashboard.php (26735 => 26736)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/includes/dashboard.php 2013-12-06 19:15:31 UTC (rev 26735)
+++ trunk/src/wp-admin/includes/dashboard.php 2013-12-06 19:17:35 UTC (rev 26736)
</span><span class="lines">@@ -311,7 +311,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 3.8.0
</span><span class="cx"> *
</span><del>- * @param string $error_msg Error message.
</del><ins>+ * @param string $error_msg Optional. Error message. Default false.
</ins><span class="cx"> */
</span><span class="cx"> function wp_dashboard_quick_press( $error_msg = false ) {
</span><span class="cx"> global $post_ID;
</span><span class="lines">@@ -545,7 +545,17 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 3.8.0
</span><span class="cx"> *
</span><del>- * @param array $args
</del><ins>+ * @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.
</ins><span class="cx"> */
</span><span class="cx"> function wp_dashboard_recent_posts( $args ) {
</span><span class="cx"> $query_args = array(
</span><span class="lines">@@ -617,7 +627,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 3.8.0
</span><span class="cx"> *
</span><del>- * @param int $total_items
</del><ins>+ * @param int $total_items Optional. Number of comments to query. Default 5.
+ * @return bool False if no comments were found. True otherwise.
</ins><span class="cx"> */
</span><span class="cx"> function wp_dashboard_recent_comments( $total_items = 5 ) {
</span><span class="cx"> global $wpdb;
</span><span class="lines">@@ -843,6 +854,9 @@
</span><span class="cx"> * Display the WordPress news feeds.
</span><span class="cx"> *
</span><span class="cx"> * @since 3.8.0
</span><ins>+ *
+ * @param string $widget_id Widget ID.
+ * @param array $feeds Array of RSS feeds.
</ins><span class="cx"> */
</span><span class="cx"> function wp_dashboard_primary_output( $widget_id, $feeds ) {
</span><span class="cx"> foreach( $feeds as $type => $args ) {
</span></span></pre></div>
<a id="trunksrcwpadminincludestemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/includes/template.php (26735 => 26736)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/includes/template.php 2013-12-06 19:15:31 UTC (rev 26735)
+++ trunk/src/wp-admin/includes/template.php 2013-12-06 19:17:35 UTC (rev 26736)
</span><span class="lines">@@ -1976,9 +1976,13 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 3.8.0
</span><span class="cx"> * @param array $args {
</span><del>- * @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.
</del><ins>+ * 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.
</ins><span class="cx"> * }
</span><span class="cx"> */
</span><span class="cx"> function wp_star_rating( $args = array() ) {
</span></span></pre></div>
<a id="trunksrcwpadminincludesthemephp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/includes/theme.php (26735 => 26736)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/includes/theme.php 2013-12-06 19:15:31 UTC (rev 26735)
+++ trunk/src/wp-admin/includes/theme.php 2013-12-06 19:17:35 UTC (rev 26736)
</span><span class="lines">@@ -113,14 +113,14 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Retrieve the update link if there is an update for a theme available.
</del><ins>+ * Retrieve the update link if there is a theme update available.
</ins><span class="cx"> *
</span><del>- * Will return a link, if there is an update available.
</del><ins>+ * Will return a link if there is an update available.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.8.0
</span><span class="cx"> *
</span><del>- * @param object $theme Theme data object.
- * @return string|bool HTML for the update link, or False if no valid info was passed.
</del><ins>+ * @param WP_Theme $theme WP_Theme object.
+ * @return string|bool HTML for the update link, or false if invalid info was passed.
</ins><span class="cx"> */
</span><span class="cx"> function get_theme_update_available( $theme ) {
</span><span class="cx"> static $themes_update;
</span></span></pre>
</div>
</div>
</body>
</html>