<!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>[24490] trunk/wp-includes: PHPDoc fixes and additions.</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/24490">24490</a></dd>

<dt>Author</dt> <dd>SergeyBiryukov</dd>

<dt>Date</dt> <dd>2013-06-21 12:45:11 +0000 (Fri, 21 Jun 2013)</dd>

</dl>

<h3>Log Message</h3>

<pre>PHPDoc fixes and additions. fixes <a href="http://core.trac.wordpress.org/ticket/24616">#24616</a>.</pre>

<h3>Modified Paths</h3>

<ul>

<li><a href="#trunkwpincludescategorytemplatephp">trunk/wp-includes/category-template.php</a></li>

<li><a href="#trunkwpincludescommentphp">trunk/wp-includes/comment.php</a></li>

<li><a href="#trunkwpincludesformattingphp">trunk/wp-includes/formatting.php</a></li>

<li><a href="#trunkwpincludesjsquicktagsjs">trunk/wp-includes/js/quicktags.js</a></li>

<li><a href="#trunkwpincludeslinktemplatephp">trunk/wp-includes/link-template.php</a></li>

<li><a href="#trunkwpincludesmetaphp">trunk/wp-includes/meta.php</a></li>

<li><a href="#trunkwpincludesposttemplatephp">trunk/wp-includes/post-template.php</a></li>

<li><a href="#trunkwpincludespostphp">trunk/wp-includes/post.php</a></li>

<li><a href="#trunkwpincludesuserphp">trunk/wp-includes/user.php</a></li>

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

<a id="trunkwpincludescategorytemplatephp"></a>

<div class="modfile"><h4>Modified: trunk/wp-includes/category-template.php (24489 => 24490)</h4>

<pre class="diff"><span>

<span class="info">--- trunk/wp-includes/category-template.php  2013-06-21 09:29:58 UTC (rev 24489)

+++ trunk/wp-includes/category-template.php     2013-06-21 12:45:11 UTC (rev 24490)

</span><span class="lines">@@ -37,7 +37,7 @@

<span class="cx">  * @param string $separator Optional, default is '/'. How to separate categories.

<span class="cx">  * @param bool $nicename Optional, default is false. Whether to use nice name for display.

<span class="cx">  * @param array $visited Optional. Already linked to categories to prevent duplicates.

</span><del>- * @return string

</del><ins>+ * @return string|WP_Error A list of category parents on success, WP_Error on failure.

</ins><span class="cx">  */

</span><span class="cx"> function get_category_parents( $id, $link = false, $separator = '/', $nicename = false, $visited = array() ) {

</span><span class="cx">  $chain = '';

</span><span class="lines">@@ -131,7 +131,7 @@

</span><span class="cx">  * @since 0.71

</span><span class="cx">  *

<span class="cx">  * @param int $cat_ID Category ID.

<del>- * @return string Category name.

</del><ins>+ * @return string|WP_Error Category name on success, WP_Error on failure.

</ins><span class="cx">  */

</span><span class="cx"> function get_the_category_by_ID( $cat_ID ) {

</span><span class="cx">  $cat_ID = (int) $cat_ID;

</span><span class="lines">@@ -980,7 +980,7 @@

<span class="cx">  * @uses apply_filters() Calls 'get_the_tags' filter on the list of post tags.

</span><span class="cx">  *

<span class="cx">  * @param int $id Post ID.

</span><del>- * @return array

</del><ins>+ * @return array|bool Array of tag objects on success, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function get_the_tags( $id = 0 ) {

</span><span class="cx">  return apply_filters( 'get_the_tags', get_the_terms( $id, 'post_tag' ) );

</span><span class="lines">@@ -996,7 +996,7 @@

<span class="cx">  * @param string $sep Optional. Between tags.

<span class="cx">  * @param string $after Optional. After tags.

<span class="cx">  * @param int $id Optional. Post ID. Defaults to the current post.

</span><del>- * @return string

</del><ins>+ * @return string|bool|WP_Error A list of tags on success, false or WP_Error on failure.

</ins><span class="cx">  */

</span><span class="cx"> function get_the_tag_list( $before = '', $sep = '', $after = '', $id = 0 ) {

</span><span class="cx">  return apply_filters( 'the_tags', get_the_term_list( $id, 'post_tag', $before, $sep, $after ), $before, $sep, $after, $id );

</span><span class="lines">@@ -1010,7 +1010,6 @@

<span class="cx">  * @param string $before Optional. Before list.

<span class="cx">  * @param string $sep Optional. Separate items using this.

<span class="cx">  * @param string $after Optional. After list.

</span><del>- * @return string

</del><span class="cx">  */

</span><span class="cx"> function the_tags( $before = null, $sep = ', ', $after = '' ) {

</span><span class="cx">  if ( null === $before )

</span><span class="lines">@@ -1054,9 +1053,9 @@

</span><span class="cx">  *

</span><span class="cx">  * @since 2.5.0

</span><span class="cx">  *

<del>- * @param mixed $post Post ID or object.

</del><ins>+ * @param int|object $post Post ID or object.

</ins><span class="cx">  * @param string $taxonomy Taxonomy name.

<del>- * @return array|bool False on failure. Array of term objects on success.

</del><ins>+ * @return array|bool|WP_Error Array of term objects on success, false or WP_Error on failure.

</ins><span class="cx">  */

</span><span class="cx"> function get_the_terms( $post, $taxonomy ) {

</span><span class="cx">  if ( ! $post = get_post( $post ) )

</span><span class="lines">@@ -1086,7 +1085,7 @@

<span class="cx">  * @param string $before Optional. Before list.

<span class="cx">  * @param string $sep Optional. Separate items using this.

<span class="cx">  * @param string $after Optional. After list.

</span><del>- * @return string

</del><ins>+ * @return string|bool|WP_Error A list of terms on success, false or WP_Error on failure.

</ins><span class="cx">  */

</span><span class="cx"> function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = '' ) {

</span><span class="cx">  $terms = get_the_terms( $id, $taxonomy );

</span></span></pre></div>

<a id="trunkwpincludescommentphp"></a>

<div class="modfile"><h4>Modified: trunk/wp-includes/comment.php (24489 => 24490)</h4>

<pre class="diff"><span>

<span class="info">--- trunk/wp-includes/comment.php    2013-06-21 09:29:58 UTC (rev 24489)

+++ trunk/wp-includes/comment.php       2013-06-21 12:45:11 UTC (rev 24490)

</span><span class="lines">@@ -539,7 +539,7 @@

<span class="cx">  * @param string $meta_key Metadata name.

<span class="cx">  * @param mixed $meta_value Metadata value.

<span class="cx">  * @param bool $unique Optional, default is false. Whether the same key should not be added.

<del>- * @return bool False for failure. True for success.

</del><ins>+ * @return int|bool Meta ID on success, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function add_comment_meta($comment_id, $meta_key, $meta_value, $unique = false) {

</span><span class="cx">  return add_metadata('comment', $comment_id, $meta_key, $meta_value, $unique);

</span><span class="lines">@@ -559,7 +559,7 @@

</span><span class="cx">  * @param int $comment_id comment ID

<span class="cx">  * @param string $meta_key Metadata name.

<span class="cx">  * @param mixed $meta_value Optional. Metadata value.

<del>- * @return bool False for failure. True for success.

</del><ins>+ * @return bool True on success, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function delete_comment_meta($comment_id, $meta_key, $meta_value = '') {

</span><span class="cx">  return delete_metadata('comment', $comment_id, $meta_key, $meta_value);

</span><span class="lines">@@ -598,7 +598,7 @@

<span class="cx">  * @param string $meta_key Metadata key.

<span class="cx">  * @param mixed $meta_value Metadata value.

<span class="cx">  * @param mixed $prev_value Optional. Previous value to check before removing.

<del>- * @return bool False on failure, true if success.

</del><ins>+ * @return bool True on success, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function update_comment_meta($comment_id, $meta_key, $meta_value, $prev_value = '') {

</span><span class="cx">  return update_metadata('comment', $comment_id, $meta_key, $meta_value, $prev_value);

</span><span class="lines">@@ -994,7 +994,7 @@

</span><span class="cx">  *

</span><span class="cx">  * @param int $comment_id Comment ID

<span class="cx">  * @param bool $force_delete Whether to bypass trash and force deletion. Default is false.

<del>- * @return bool False if delete comment query failure, true on success.

</del><ins>+ * @return bool True on success, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function wp_delete_comment($comment_id, $force_delete = false) {

</span><span class="cx">  global $wpdb;

</span><span class="lines">@@ -1044,7 +1044,7 @@

</span><span class="cx">  * @uses wp_delete_comment() if trash is disabled

</span><span class="cx">  *

<span class="cx">  * @param int $comment_id Comment ID.

</span><del>- * @return mixed False on failure

</del><ins>+ * @return bool True on success, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function wp_trash_comment($comment_id) {

</span><span class="cx">  if ( !EMPTY_TRASH_DAYS )

</span><span class="lines">@@ -1073,7 +1073,7 @@

</span><span class="cx">  * @uses do_action() on 'untrashed_comment' after untrashing

</span><span class="cx">  *

<span class="cx">  * @param int $comment_id Comment ID.

</span><del>- * @return mixed False on failure

</del><ins>+ * @return bool True on success, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function wp_untrash_comment($comment_id) {

</span><span class="cx">  if ( ! (int)$comment_id )

</span><span class="lines">@@ -1103,7 +1103,7 @@

</span><span class="cx">  * @uses do_action() on 'spammed_comment' after spamming

</span><span class="cx">  *

<span class="cx">  * @param int $comment_id Comment ID.

</span><del>- * @return mixed False on failure

</del><ins>+ * @return bool True on success, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function wp_spam_comment($comment_id) {

</span><span class="cx">  if ( !$comment = get_comment($comment_id) )

</span><span class="lines">@@ -1128,7 +1128,7 @@

</span><span class="cx">  * @uses do_action() on 'unspammed_comment' after unspamming

</span><span class="cx">  *

<span class="cx">  * @param int $comment_id Comment ID.

</span><del>- * @return mixed False on failure

</del><ins>+ * @return bool True on success, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function wp_unspam_comment($comment_id) {

</span><span class="cx">  if ( ! (int)$comment_id )

</span><span class="lines">@@ -1423,7 +1423,7 @@

<span class="cx">  * @param int $comment_id Comment ID.

<span class="cx">  * @param string $comment_status New comment status, either 'hold', 'approve', 'spam', or 'trash'.

<span class="cx">  * @param bool $wp_error Whether to return a WP_Error object if there is a failure. Default is false.

<del>- * @return bool False on failure or deletion and true on success.

</del><ins>+ * @return bool|WP_Error True on success, false or WP_Error on failure.

</ins><span class="cx">  */

</span><span class="cx"> function wp_set_comment_status($comment_id, $comment_status, $wp_error = false) {

</span><span class="cx">  global $wpdb;

</span><span class="lines">@@ -1601,7 +1601,7 @@

</span><span class="cx">  * @uses do_action() Calls 'edit_posts' hook on $post_id and $post

</span><span class="cx">  *

</span><span class="cx">  * @param int $post_id Post ID

<del>- * @return bool False on '0' $post_id or if post with ID does not exist. True on success.

</del><ins>+ * @return bool True on success, false on '0' $post_id or if post with ID does not exist.

</ins><span class="cx">  */

</span><span class="cx"> function wp_update_comment_count_now($post_id) {

</span><span class="cx">  global $wpdb;

</span></span></pre></div>

<a id="trunkwpincludesformattingphp"></a>

<div class="modfile"><h4>Modified: trunk/wp-includes/formatting.php (24489 => 24490)</h4>

<pre class="diff"><span>

<span class="info">--- trunk/wp-includes/formatting.php 2013-06-21 09:29:58 UTC (rev 24489)

+++ trunk/wp-includes/formatting.php    2013-06-21 12:45:11 UTC (rev 24490)

</span><span class="lines">@@ -3116,7 +3116,7 @@

</span><span class="cx">  *

</span><span class="cx">  * @since 2.5.0

</span><span class="cx">  *

<del>- * @param integer $str String to get the excerpt from.

</del><ins>+ * @param string $str String to get the excerpt from.

</ins><span class="cx">  * @param integer $count Maximum number of characters to take.

<span class="cx">  * @param string $more Optional. What to append if $str needs to be trimmed. Defaults to empty string.

<span class="cx">  * @return string The excerpt.

</span></span></pre></div>

<a id="trunkwpincludesjsquicktagsjs"></a>

<div class="modfile"><h4>Modified: trunk/wp-includes/js/quicktags.js (24489 => 24490)</h4>

<pre class="diff"><span>

<span class="info">--- trunk/wp-includes/js/quicktags.js        2013-06-21 09:29:58 UTC (rev 24489)

+++ trunk/wp-includes/js/quicktags.js   2013-06-21 12:45:11 UTC (rev 24490)

</span><span class="lines">@@ -296,14 +296,14 @@

</span><span class="cx">   *     QTags.addButton( 'my_id', 'my button', '<span>', '</span>' );

</span><span class="cx">   *     QTags.addButton( 'my_id2', 'my button', '<br />' );

</span><span class="cx">   *

</span><del>-        * @param id string required Button HTML ID

-        * @param display string required Button's value="..."

-        * @param arg1 string || function required Either a starting tag to be inserted like "<span>" or a callback that is executed when the button is clicked.

-        * @param arg2 string optional Ending tag like "</span>"

-        * @param access_key string optional Access key for the button.

-        * @param title string optional Button's title="..."

-        * @param priority int optional Number representing the desired position of the button in the toolbar. 1 - 9 = first, 11 - 19 = second, 21 - 29 = third, etc.

-        * @param instance string optional Limit the button to a specifric instance of Quicktags, add to all instances if not present.

</del><ins>+         * @param string id Required. Button HTML ID

+        * @param string display Required. Button's value="..."

+        * @param string|function arg1 Required. Either a starting tag to be inserted like "<span>" or a callback that is executed when the button is clicked.

+        * @param string arg2 Optional. Ending tag like "</span>"

+        * @param string access_key Optional. Access key for the button.

+        * @param string title Optional. Button's title="..."

+        * @param int priority Optional. Number representing the desired position of the button in the toolbar. 1 - 9 = first, 11 - 19 = second, 21 - 29 = third, etc.

+        * @param string instance Optional. Limit the button to a specifric instance of Quicktags, add to all instances if not present.

</ins><span class="cx">    * @return mixed null or the button object that is needed for back-compat.

</span><span class="cx">   */

</span><span class="cx">  qt.addButton = function( id, display, arg1, arg2, access_key, title, priority, instance ) {

</span></span></pre></div>

<a id="trunkwpincludeslinktemplatephp"></a>

<div class="modfile"><h4>Modified: trunk/wp-includes/link-template.php (24489 => 24490)</h4>

<pre class="diff"><span>

<span class="info">--- trunk/wp-includes/link-template.php      2013-06-21 09:29:58 UTC (rev 24489)

+++ trunk/wp-includes/link-template.php 2013-06-21 12:45:11 UTC (rev 24490)

</span><span class="lines">@@ -232,7 +232,7 @@

</span><span class="cx">  *

</span><span class="cx">  * @since 1.5.0

</span><span class="cx">  *

<del>- * @param mixed $post Optional. Post ID or object.

</del><ins>+ * @param int|object $post Optional. Post ID or object.

</ins><span class="cx">  * @param bool $leavename Optional, defaults to false. Whether to keep page name.

<span class="cx">  * @param bool $sample Optional, defaults to false. Is it a sample permalink.

</span><span class="cx">  * @return string

</span><span class="lines">@@ -256,7 +256,7 @@

</span><span class="cx">  * @since 2.1.0

</span><span class="cx">  * @access private

</span><span class="cx">  *

<del>- * @param mixed $post Optional. Post ID or object.

</del><ins>+ * @param int|object $post Optional. Post ID or object.

</ins><span class="cx">  * @param bool $leavename Optional. Leave name.

<span class="cx">  * @param bool $sample Optional. Sample permalink.

</span><span class="cx">  * @return string

</span><span class="lines">@@ -291,7 +291,7 @@

</span><span class="cx">  *

</span><span class="cx">  * @since 2.0.0

</span><span class="cx">  *

<del>- * @param mixed $post Optional. Post ID or object.

</del><ins>+ * @param int|object $post Optional. Post ID or object.

</ins><span class="cx">  * @param bool $leavename Optional. Leave name.

</span><span class="cx">  * @return string

</span><span class="cx">  */

</span></span></pre></div>

<a id="trunkwpincludesmetaphp"></a>

<div class="modfile"><h4>Modified: trunk/wp-includes/meta.php (24489 => 24490)</h4>

<pre class="diff"><span>

<span class="info">--- trunk/wp-includes/meta.php       2013-06-21 09:29:58 UTC (rev 24489)

+++ trunk/wp-includes/meta.php  2013-06-21 12:45:11 UTC (rev 24490)

</span><span class="lines">@@ -26,7 +26,7 @@

</span><span class="cx">  * @param bool $unique Optional, default is false. Whether the specified metadata key should be

</span><span class="cx">  *               unique for the object. If true, and the object already has a value for the specified

</span><span class="cx">  *               metadata key, no change will be made

<del>- * @return bool The meta ID on successful update, false on failure.

</del><ins>+ * @return int|bool The meta ID on successful update, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function add_metadata($meta_type, $object_id, $meta_key, $meta_value, $unique = false) {

</span><span class="cx">  if ( !$meta_type || !$meta_key )

</span></span></pre></div>

<a id="trunkwpincludesposttemplatephp"></a>

<div class="modfile"><h4>Modified: trunk/wp-includes/post-template.php (24489 => 24490)</h4>

<pre class="diff"><span>

<span class="info">--- trunk/wp-includes/post-template.php      2013-06-21 09:29:58 UTC (rev 24489)

+++ trunk/wp-includes/post-template.php 2013-06-21 12:45:11 UTC (rev 24490)

</span><span class="lines">@@ -96,7 +96,7 @@

</span><span class="cx">  *

</span><span class="cx">  * @since 0.71

</span><span class="cx">  *

<del>- * @param mixed $post Optional. Post ID or object.

</del><ins>+ * @param int|object $post Optional. Post ID or object.

</ins><span class="cx">  * @return string

</span><span class="cx">  */

</span><span class="cx"> function get_the_title( $post = 0 ) {

</span><span class="lines">@@ -1265,7 +1265,7 @@

</span><span class="cx">  * @uses $wp_query

</span><span class="cx">  *

<span class="cx">  * @param string $template The specific template name if specific matching is required.

<del>- * @return bool False on failure, true if success.

</del><ins>+ * @return bool True on success, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function is_page_template( $template = '' ) {

</span><span class="cx">  if ( ! is_page() )

</span></span></pre></div>

<a id="trunkwpincludespostphp"></a>

<div class="modfile"><h4>Modified: trunk/wp-includes/post.php (24489 => 24490)</h4>

<pre class="diff"><span>

<span class="info">--- trunk/wp-includes/post.php       2013-06-21 09:29:58 UTC (rev 24489)

+++ trunk/wp-includes/post.php  2013-06-21 12:45:11 UTC (rev 24490)

</span><span class="lines">@@ -203,7 +203,7 @@

</span><span class="cx">  *

</span><span class="cx">  * @param int $attachment_id Attachment ID

</span><span class="cx">  * @param string $file File path for the attachment

<del>- * @return bool False on failure, true on success.

</del><ins>+ * @return bool True on success, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function update_attached_file( $attachment_id, $file ) {

</span><span class="cx">  if ( !get_post( $attachment_id ) )

</span><span class="lines">@@ -724,10 +724,10 @@

</span><span class="cx">  * @since 2.3.0

<span class="cx">  * @uses sanitize_post_field() See for possible $context values.

</span><span class="cx">  *

</span><del>- * @param string $field Post field name

- * @param id $post Post ID

- * @param string $context Optional. How to filter the field. Default is display.

- * @return bool|string False on failure or returns the value in post field

</del><ins>+ * @param string $field Post field name.

+ * @param int|object $post Post ID or post object.

+ * @param string $context Optional. How to filter the field. Default is 'display'.

+ * @return string The value of the post field on success, empty string on failure.

</ins><span class="cx">  */

</span><span class="cx"> function get_post_field( $field, $post, $context = 'display' ) {

</span><span class="cx">  $post = get_post( $post );

</span><span class="lines">@@ -749,8 +749,8 @@

</span><span class="cx">  *

</span><span class="cx">  * @since 2.0.0

</span><span class="cx">  *

<del>- * @param int $ID Optional. Post ID.

- * @return bool|string False on failure or returns the mime type

</del><ins>+ * @param int $ID Optional. Post ID. Default is the current post from the loop.

+ * @return string|bool The mime type on success, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function get_post_mime_type($ID = '') {

</span><span class="cx">  $post = get_post($ID);

</span><span class="lines">@@ -769,8 +769,8 @@

</span><span class="cx">  *

</span><span class="cx">  * @since 2.0.0

</span><span class="cx">  *

</span><del>- * @param int $ID Post ID

- * @return string|bool Post status or false on failure.

</del><ins>+ * @param int $ID Optional. Post ID. Default is the current post from the loop.

+ * @return string|bool Post status on success, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function get_post_status($ID = '') {

</span><span class="cx">  $post = get_post($ID);

</span><span class="lines">@@ -1009,10 +1009,8 @@

</span><span class="cx">  *

</span><span class="cx">  * @since 2.1.0

</span><span class="cx">  *

</span><del>- * @uses $post The Loop current post global

- *

- * @param mixed $post Optional. Post object or post ID.

- * @return bool|string post type or false on failure.

</del><ins>+ * @param int|object $post Optional. Post ID or post object. Default is the current post from the loop.

+ * @return string|bool Post type on success, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function get_post_type( $post = null ) {

</span><span class="cx">  if ( $post = get_post( $post ) )

</span><span class="lines">@@ -1675,7 +1673,7 @@

<span class="cx">  * @param string $meta_key Metadata name.

<span class="cx">  * @param mixed $meta_value Metadata value.

<span class="cx">  * @param bool $unique Optional, default is false. Whether the same key should not be added.

<del>- * @return bool False for failure. True for success.

</del><ins>+ * @return int|bool Meta ID on success, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function add_post_meta($post_id, $meta_key, $meta_value, $unique = false) {

</span><span class="cx">  // make sure meta is added to the post, not a revision

</span><span class="lines">@@ -1699,7 +1697,7 @@

</span><span class="cx">  * @param int $post_id post ID

<span class="cx">  * @param string $meta_key Metadata name.

<span class="cx">  * @param mixed $meta_value Optional. Metadata value.

<del>- * @return bool False for failure. True for success.

</del><ins>+ * @return bool True on success, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function delete_post_meta($post_id, $meta_key, $meta_value = '') {

</span><span class="cx">  // make sure meta is added to the post, not a revision

</span><span class="lines">@@ -1742,7 +1740,7 @@

<span class="cx">  * @param string $meta_key Metadata key.

<span class="cx">  * @param mixed $meta_value Metadata value.

<span class="cx">  * @param mixed $prev_value Optional. Previous value to check before removing.

<del>- * @return bool False on failure, true if success.

</del><ins>+ * @return bool True on success, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function update_post_meta($post_id, $meta_key, $meta_value, $prev_value = '') {

</span><span class="cx">  // make sure meta is added to the post, not a revision

</span><span class="lines">@@ -2391,7 +2389,7 @@

</span><span class="cx">  * @uses do_action() on 'trash_post_comments' before trashing

</span><span class="cx">  * @uses do_action() on 'trashed_post_comments' after trashing

</span><span class="cx">  *

<del>- * @param int $post Post ID or object.

</del><ins>+ * @param int|object $post Post ID or object.

</ins><span class="cx">  * @return mixed False on failure

</span><span class="cx">  */

</span><span class="cx"> function wp_trash_post_comments($post = null) {

</span><span class="lines">@@ -2432,7 +2430,7 @@

</span><span class="cx">  * @uses do_action() on 'untrash_post_comments' before trashing

</span><span class="cx">  * @uses do_action() on 'untrashed_post_comments' after trashing

</span><span class="cx">  *

<del>- * @param int $post Post ID or object.

</del><ins>+ * @param int|object $post Post ID or object.

</ins><span class="cx">  * @return mixed False on failure

</span><span class="cx">  */

</span><span class="cx"> function wp_untrash_post_comments($post = null) {

</span><span class="lines">@@ -2953,7 +2951,7 @@

</span><span class="cx">  * @uses $wpdb

<span class="cx">  * @uses do_action() Calls 'edit_post', 'save_post', and 'wp_insert_post' on post_id and post data.

</span><span class="cx">  *

<del>- * @param mixed $post Post ID or object.

</del><ins>+ * @param int|object $post Post ID or object.

</ins><span class="cx">  */

</span><span class="cx"> function wp_publish_post( $post ) {

</span><span class="cx">  global $wpdb;

</span><span class="lines">@@ -4606,7 +4604,7 @@

</span><span class="cx">  *

<span class="cx">  * @uses do_action() Calls 'clean_post_cache' on $id before adding children (if any).

</span><span class="cx">  *

</span><del>- * @param object|int $post The post object or ID to remove from the cache

</del><ins>+ * @param int|object $post Post ID or object to remove from the cache

</ins><span class="cx">  */

</span><span class="cx"> function clean_post_cache( $post ) {

</span><span class="cx">  global $_wp_suspend_cache_invalidation, $wpdb;

</span></span></pre></div>

<a id="trunkwpincludesuserphp"></a>

<div class="modfile"><h4>Modified: trunk/wp-includes/user.php (24489 => 24490)</h4>

<pre class="diff"><span>

<span class="info">--- trunk/wp-includes/user.php       2013-06-21 09:29:58 UTC (rev 24489)

+++ trunk/wp-includes/user.php  2013-06-21 12:45:11 UTC (rev 24490)

</span><span class="lines">@@ -791,7 +791,7 @@

<span class="cx">  * @param string $meta_key Metadata name.

<span class="cx">  * @param mixed $meta_value Metadata value.

<span class="cx">  * @param bool $unique Optional, default is false. Whether the same key should not be added.

<del>- * @return bool False for failure. True for success.

</del><ins>+ * @return int|bool Meta ID on success, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function add_user_meta($user_id, $meta_key, $meta_value, $unique = false) {

</span><span class="cx">  return add_metadata('user', $user_id, $meta_key, $meta_value, $unique);

</span><span class="lines">@@ -811,7 +811,7 @@

</span><span class="cx">  * @param int $user_id user ID

<span class="cx">  * @param string $meta_key Metadata name.

<span class="cx">  * @param mixed $meta_value Optional. Metadata value.

<del>- * @return bool False for failure. True for success.

</del><ins>+ * @return bool True on success, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function delete_user_meta($user_id, $meta_key, $meta_value = '') {

</span><span class="cx">  return delete_metadata('user', $user_id, $meta_key, $meta_value);

</span><span class="lines">@@ -850,7 +850,7 @@

<span class="cx">  * @param string $meta_key Metadata key.

<span class="cx">  * @param mixed $meta_value Metadata value.

<span class="cx">  * @param mixed $prev_value Optional. Previous value to check before removing.

<del>- * @return bool False on failure, true if success.

</del><ins>+ * @return bool True on success, false on failure.

</ins><span class="cx">  */

</span><span class="cx"> function update_user_meta($user_id, $meta_key, $meta_value, $prev_value = '') {

</span><span class="cx">  return update_metadata('user', $user_id, $meta_key, $meta_value, $prev_value);

</span></span></pre>

</div>

</div>

</body>

</html>