<!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>[29094] trunk/src/wp-includes/post.php: General inline documentation improvements in wp-includes/post.php.</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/29094">29094</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-07-11 11:15:49 +0000 (Fri, 11 Jul 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>General inline documentation improvements in wp-includes/post.php.
Final-run. Fixes <a href="http://core.trac.wordpress.org/ticket/25412">#25412</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludespostphp">trunk/src/wp-includes/post.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludespostphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/post.php (29093 => 29094)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/post.php 2014-07-11 10:27:02 UTC (rev 29093)
+++ trunk/src/wp-includes/post.php 2014-07-11 11:15:49 UTC (rev 29094)
</span><span class="lines">@@ -4722,7 +4722,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Trashes or deletes an attachment.
</del><ins>+ * Trash or delete an attachment.
</ins><span class="cx"> *
</span><span class="cx"> * When an attachment is permanently deleted, the file will also be removed.
</span><span class="cx"> * Deletion removes all post meta fields, taxonomy, comments, etc. associated
</span><span class="lines">@@ -4732,10 +4732,12 @@
</span><span class="cx"> * for media is disabled, item is already in the trash, or $force_delete is true.
</span><span class="cx"> *
</span><span class="cx"> * @since 2.0.0
</span><del>- * @uses $wpdb
</del><span class="cx"> *
</span><del>- * @param int $post_id Attachment ID.
- * @param bool $force_delete Whether to bypass trash and force deletion. Defaults to false.
</del><ins>+ * @global wpdb $wpdb WordPress database access abstraction object.
+ *
+ * @param int $post_id Attachment ID.
+ * @param bool $force_delete Optional. Whether to bypass trash and force deletion.
+ * Default false.
</ins><span class="cx"> * @return mixed False on failure. Post data on success.
</span><span class="cx"> */
</span><span class="cx"> function wp_delete_attachment( $post_id, $force_delete = false ) {
</span><span class="lines">@@ -4800,7 +4802,7 @@
</span><span class="cx"> $uploadpath = wp_upload_dir();
</span><span class="cx">
</span><span class="cx"> if ( ! empty($meta['thumb']) ) {
</span><del>- // Don't delete the thumb if another attachment uses it
</del><ins>+ // Don't delete the thumb if another attachment uses it.
</ins><span class="cx"> if (! $wpdb->get_row( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE meta_key = '_wp_attachment_metadata' AND meta_value LIKE %s AND post_id <> %d", '%' . $wpdb->esc_like( $meta['thumb'] ) . '%', $post_id)) ) {
</span><span class="cx"> $thumbfile = str_replace(basename($file), $meta['thumb'], $file);
</span><span class="cx"> /** This filter is documented in wp-admin/custom-header.php */
</span><span class="lines">@@ -4809,7 +4811,7 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // remove intermediate and backup images if there are any
</del><ins>+ // Remove intermediate and backup images if there are any.
</ins><span class="cx"> foreach ( $intermediate_sizes as $intermediate ) {
</span><span class="cx"> /** This filter is documented in wp-admin/custom-header.php */
</span><span class="cx"> $intermediate_file = apply_filters( 'wp_delete_file', $intermediate['path'] );
</span><span class="lines">@@ -4841,8 +4843,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.1.0
</span><span class="cx"> *
</span><del>- * @param int $post_id Attachment ID. Default 0.
- * @param bool $unfiltered Optional, default is false. If true, filters are not run.
</del><ins>+ * @param int $post_id Attachment ID. Default 0.
+ * @param bool $unfiltered Optional. If true, filters are not run. Default false.
</ins><span class="cx"> * @return string|bool Attachment meta field. False on failure.
</span><span class="cx"> */
</span><span class="cx"> function wp_get_attachment_metadata( $post_id = 0, $unfiltered = false ) {
</span><span class="lines">@@ -4872,9 +4874,9 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.1.0
</span><span class="cx"> *
</span><del>- * @param int $post_id Attachment ID.
- * @param array $data Attachment data.
- * @return int
</del><ins>+ * @param int $post_id Attachment ID.
+ * @param array $data Attachment data.
+ * @return int|bool False if $post is invalid.
</ins><span class="cx"> */
</span><span class="cx"> function wp_update_attachment_metadata( $post_id, $data ) {
</span><span class="cx"> $post_id = (int) $post_id;
</span><span class="lines">@@ -4901,7 +4903,7 @@
</span><span class="cx"> * @since 2.1.0
</span><span class="cx"> *
</span><span class="cx"> * @param int $post_id Optional. Attachment ID. Default 0.
</span><del>- * @return string
</del><ins>+ * @return string|bool Attachment URL, otherwise false.
</ins><span class="cx"> */
</span><span class="cx"> function wp_get_attachment_url( $post_id = 0 ) {
</span><span class="cx"> $post_id = (int) $post_id;
</span><span class="lines">@@ -4912,19 +4914,30 @@
</span><span class="cx"> return false;
</span><span class="cx">
</span><span class="cx"> $url = '';
</span><del>- if ( $file = get_post_meta( $post->ID, '_wp_attached_file', true) ) { //Get attached file
- if ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) { //Get upload directory
- if ( 0 === strpos($file, $uploads['basedir']) ) //Check that the upload base exists in the file location
- $url = str_replace($uploads['basedir'], $uploads['baseurl'], $file); //replace file location with url location
- elseif ( false !== strpos($file, 'wp-content/uploads') )
</del><ins>+ // Get attached file.
+ if ( $file = get_post_meta( $post->ID, '_wp_attached_file', true) ) {
+ // Get upload directory.
+ if ( ($uploads = wp_upload_dir()) && false === $uploads['error'] ) {
+ // Check that the upload base exists in the file location.
+ if ( 0 === strpos( $file, $uploads['basedir'] ) ) {
+ // Replace file location with url location.
+ $url = str_replace($uploads['basedir'], $uploads['baseurl'], $file);
+ } elseif ( false !== strpos($file, 'wp-content/uploads') ) {
</ins><span class="cx"> $url = $uploads['baseurl'] . substr( $file, strpos($file, 'wp-content/uploads') + 18 );
</span><del>- else
- $url = $uploads['baseurl'] . "/$file"; //Its a newly uploaded file, therefor $file is relative to the basedir.
</del><ins>+ } else {
+ // It's a newly-uploaded file, therefore $file is relative to the basedir.
+ $url = $uploads['baseurl'] . "/$file";
+ }
</ins><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><del>- if ( empty($url) ) //If any of the above options failed, Fallback on the GUID as used pre-2.7, not recommended to rely upon this.
</del><ins>+ /*
+ * If any of the above options failed, Fallback on the GUID as used pre-2.7,
+ * not recommended to rely upon this.
+ */
+ if ( empty($url) ) {
</ins><span class="cx"> $url = get_the_guid( $post->ID );
</span><ins>+ }
</ins><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * Filter the attachment URL.
</span><span class="lines">@@ -5039,7 +5052,7 @@
</span><span class="cx"> * @since 2.1.0
</span><span class="cx"> *
</span><span class="cx"> * @param string|int $mime MIME type or attachment ID.
</span><del>- * @return string|bool
</del><ins>+ * @return string|bool Icon, false otherwise.
</ins><span class="cx"> */
</span><span class="cx"> function wp_mime_type_icon( $mime = 0 ) {
</span><span class="cx"> if ( !is_numeric($mime) )
</span><span class="lines">@@ -5118,7 +5131,7 @@
</span><span class="cx"> wp_cache_add( 'icon_files', $icon_files, 'default', 600 );
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // Icon basename - extension = MIME wildcard
</del><ins>+ // Icon basename - extension = MIME wildcard.
</ins><span class="cx"> foreach ( $icon_files as $file => $uri )
</span><span class="cx"> $types[ preg_replace('/^([^.]*).*$/', '$1', basename($file)) ] =& $icon_files[$file];
</span><span class="cx">
</span><span class="lines">@@ -5155,7 +5168,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Checked for changed slugs for published post objects and save the old slug.
</del><ins>+ * Check for changed slugs for published post objects and save the old slug.
</ins><span class="cx"> *
</span><span class="cx"> * The function is used when a post object of any type is updated,
</span><span class="cx"> * by comparing the current and previous post objects.
</span><span class="lines">@@ -5169,27 +5182,27 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.1.0
</span><span class="cx"> *
</span><del>- * @param int $post_id Post ID.
- * @param object $post The Post Object
- * @param object $post_before The Previous Post Object
</del><ins>+ * @param int $post_id Post ID.
+ * @param WP_Post $post The Post Object
+ * @param WP_Post $post_before The Previous Post Object
</ins><span class="cx"> * @return int Same as $post_id
</span><span class="cx"> */
</span><del>-function wp_check_for_changed_slugs($post_id, $post, $post_before) {
- // dont bother if it hasnt changed
</del><ins>+function wp_check_for_changed_slugs( $post_id, $post, $post_before ) {
+ // Don't bother if it hasnt changed.
</ins><span class="cx"> if ( $post->post_name == $post_before->post_name )
</span><span class="cx"> return;
</span><span class="cx">
</span><del>- // we're only concerned with published, non-hierarchical objects
</del><ins>+ // We're only concerned with published, non-hierarchical objects.
</ins><span class="cx"> if ( $post->post_status != 'publish' || is_post_type_hierarchical( $post->post_type ) )
</span><span class="cx"> return;
</span><span class="cx">
</span><span class="cx"> $old_slugs = (array) get_post_meta($post_id, '_wp_old_slug');
</span><span class="cx">
</span><del>- // if we haven't added this old slug before, add it now
</del><ins>+ // If we haven't added this old slug before, add it now.
</ins><span class="cx"> if ( !empty( $post_before->post_name ) && !in_array($post_before->post_name, $old_slugs) )
</span><span class="cx"> add_post_meta($post_id, '_wp_old_slug', $post_before->post_name);
</span><span class="cx">
</span><del>- // if the new slug was used previously, delete it from the list
</del><ins>+ // If the new slug was used previously, delete it from the list.
</ins><span class="cx"> if ( in_array($post->post_name, $old_slugs) )
</span><span class="cx"> delete_post_meta($post_id, '_wp_old_slug', $post->post_name);
</span><span class="cx"> }
</span><span class="lines">@@ -5204,7 +5217,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.2.0
</span><span class="cx"> *
</span><del>- * @param string $post_type currently only supports 'post' or 'page'.
</del><ins>+ * @param string $post_type Post type. Currently only supports 'post' or 'page'.
</ins><span class="cx"> * @return string SQL code that can be added to a where clause.
</span><span class="cx"> */
</span><span class="cx"> function get_private_posts_cap_sql( $post_type ) {
</span><span class="lines">@@ -5214,19 +5227,22 @@
</span><span class="cx"> /**
</span><span class="cx"> * Retrieve the post SQL based on capability, author, and type.
</span><span class="cx"> *
</span><ins>+ * @since 3.0.0
+ *
</ins><span class="cx"> * @see get_private_posts_cap_sql()
</span><span class="cx"> *
</span><del>- * @since 3.0.0
- * @param string $post_type Post type.
- * @param bool $full Optional. Returns a full WHERE statement instead of just an 'andalso' term.
- * @param int $post_author Optional. Query posts having a single author ID.
- * @param bool $public_only Optional. Only return public posts. Skips cap checks for $current_user. Default is false.
</del><ins>+ * @param string $post_type Post type.
+ * @param bool $full Optional. Returns a full WHERE statement instead of just
+ * an 'andalso' term. Default true.
+ * @param int $post_author Optional. Query posts having a single author ID. Default null.
+ * @param bool $public_only Optional. Only return public posts. Skips cap checks for
+ * $current_user. Default false.
</ins><span class="cx"> * @return string SQL WHERE code that can be added to a query.
</span><span class="cx"> */
</span><span class="cx"> function get_posts_by_author_sql( $post_type, $full = true, $post_author = null, $public_only = false ) {
</span><span class="cx"> global $wpdb;
</span><span class="cx">
</span><del>- // Private posts
</del><ins>+ // Private posts.
</ins><span class="cx"> $post_type_obj = get_post_type_object( $post_type );
</span><span class="cx"> if ( ! $post_type_obj )
</span><span class="cx"> return $full ? 'WHERE 1 = 0' : ' 1 = 0 ';
</span><span class="lines">@@ -5286,10 +5302,11 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 0.71
</span><span class="cx"> *
</span><del>- * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'.
</del><ins>+ * @param string $timezone The location to get the time. Accepts 'gmt', 'blog',
+ * or 'server'. Default 'server'.
</ins><span class="cx"> * @return string The date of the last post.
</span><span class="cx"> */
</span><del>-function get_lastpostdate($timezone = 'server') {
</del><ins>+function get_lastpostdate( $timezone = 'server' ) {
</ins><span class="cx"> /**
</span><span class="cx"> * Filter the date the last post was published.
</span><span class="cx"> *
</span><span class="lines">@@ -5311,10 +5328,11 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.2.0
</span><span class="cx"> *
</span><del>- * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'.
</del><ins>+ * @param string $timezone The location to get the time. Accepts 'gmt', 'blog', or 'server'.
+ * Default 'server'.
</ins><span class="cx"> * @return string The date the post was last modified.
</span><span class="cx"> */
</span><del>-function get_lastpostmodified($timezone = 'server') {
</del><ins>+function get_lastpostmodified( $timezone = 'server' ) {
</ins><span class="cx"> $lastpostmodified = _get_last_post_time( $timezone, 'modified' );
</span><span class="cx">
</span><span class="cx"> $lastpostdate = get_lastpostdate($timezone);
</span><span class="lines">@@ -5338,7 +5356,7 @@
</span><span class="cx"> * @access private
</span><span class="cx"> * @since 3.1.0
</span><span class="cx"> *
</span><del>- * @param string $timezone The location to get the time. Can be 'gmt', 'blog', or 'server'.
</del><ins>+ * @param string $timezone The location to get the time. Accepts 'gmt', 'blog', or 'server'.
</ins><span class="cx"> * @param string $field Field to check. Can be 'date' or 'modified'.
</span><span class="cx"> * @return string The date.
</span><span class="cx"> */
</span><span class="lines">@@ -5385,7 +5403,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.1
</span><span class="cx"> *
</span><del>- * @param array $posts Array of post objects
</del><ins>+ * @param array $posts Array of post objects, passed by reference.
</ins><span class="cx"> */
</span><span class="cx"> function update_post_cache( &$posts ) {
</span><span class="cx"> if ( ! $posts )
</span><span class="lines">@@ -5406,6 +5424,8 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.0.0
</span><span class="cx"> *
</span><ins>+ * @global wpdb $wpdb WordPress database access abstraction object.
+ *
</ins><span class="cx"> * @param int|WP_Post $post Post ID or post object to remove from the cache.
</span><span class="cx"> */
</span><span class="cx"> function clean_post_cache( $post ) {
</span><span class="lines">@@ -5456,16 +5476,12 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><del>- * @uses update_post_cache()
- * @uses update_object_term_cache()
- * @uses update_postmeta_cache()
- *
- * @param array $posts Array of Post objects
- * @param string $post_type The post type of the posts in $posts. Default is 'post'.
- * @param bool $update_term_cache Whether to update the term cache. Default is true.
- * @param bool $update_meta_cache Whether to update the meta cache. Default is true.
</del><ins>+ * @param array $posts Array of Post objects
+ * @param string $post_type Optional. Post type. Default 'post'.
+ * @param bool $update_term_cache Optional. Whether to update the term cache. Default true.
+ * @param bool $update_meta_cache Optional. Whether to update the meta cache. Default true.
</ins><span class="cx"> */
</span><del>-function update_post_caches(&$posts, $post_type = 'post', $update_term_cache = true, $update_meta_cache = true) {
</del><ins>+function update_post_caches( &$posts, $post_type = 'post', $update_term_cache = true, $update_meta_cache = true ) {
</ins><span class="cx"> // No point in doing all this work if we didn't match any posts.
</span><span class="cx"> if ( !$posts )
</span><span class="cx"> return;
</span><span class="lines">@@ -5509,9 +5525,10 @@
</span><span class="cx"> * @since 2.1.0
</span><span class="cx"> *
</span><span class="cx"> * @param array $post_ids List of post IDs.
</span><del>- * @return bool|array Returns false if there is nothing to update or an array of metadata.
</del><ins>+ * @return bool|array Returns false if there is nothing to update or an array
+ * of metadata.
</ins><span class="cx"> */
</span><del>-function update_postmeta_cache($post_ids) {
</del><ins>+function update_postmeta_cache( $post_ids ) {
</ins><span class="cx"> return update_meta_cache('post', $post_ids);
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -5521,15 +5538,16 @@
</span><span class="cx"> * Cleaning means delete from the cache. Optionally will clean the term
</span><span class="cx"> * object cache associated with the attachment ID.
</span><span class="cx"> *
</span><del>- * This function will not run if $_wp_suspend_cache_invalidation is not empty. See
- * wp_suspend_cache_invalidation().
</del><ins>+ * This function will not run if $_wp_suspend_cache_invalidation is not empty.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><del>- * @param int $id The attachment ID in the cache to clean
- * @param bool $clean_terms optional. Whether to clean terms cache
</del><ins>+ * @see wp_suspend_cache_invalidation()
+ *
+ * @param int $id The attachment ID in the cache to clean.
+ * @param bool $clean_terms Optional. Whether to clean terms cache. Default false.
</ins><span class="cx"> */
</span><del>-function clean_attachment_cache($id, $clean_terms = false) {
</del><ins>+function clean_attachment_cache( $id, $clean_terms = false ) {
</ins><span class="cx"> global $_wp_suspend_cache_invalidation;
</span><span class="cx">
</span><span class="cx"> if ( !empty($_wp_suspend_cache_invalidation) )
</span><span class="lines">@@ -5562,14 +5580,15 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.3.0
</span><span class="cx"> * @access private
</span><del>- * @uses $wpdb
- * @uses wp_clear_scheduled_hook() with 'publish_future_post' and post ID.
</del><span class="cx"> *
</span><del>- * @param string $new_status New post status
- * @param string $old_status Previous post status
- * @param object $post Object type containing the post information
</del><ins>+ * @see wp_clear_scheduled_hook()
+ * @global wpdb $wpdb WordPress database access abstraction object.
+ *
+ * @param string $new_status New post status.
+ * @param string $old_status Previous post status.
+ * @param WP_Post $post Post object.
</ins><span class="cx"> */
</span><del>-function _transition_post_status($new_status, $old_status, $post) {
</del><ins>+function _transition_post_status( $new_status, $old_status, $post ) {
</ins><span class="cx"> global $wpdb;
</span><span class="cx">
</span><span class="cx"> if ( $old_status != 'publish' && $new_status == 'publish' ) {
</span><span class="lines">@@ -5613,10 +5632,11 @@
</span><span class="cx"> * @since 2.3.0
</span><span class="cx"> * @access private
</span><span class="cx"> *
</span><del>- * @param int $deprecated Not used. Can be set to null. Never implemented.
- * Not marked as deprecated with _deprecated_argument() as it conflicts with
- * wp_transition_post_status() and the default filter for _future_post_hook().
- * @param object $post Object type containing the post information
</del><ins>+ * @param int $deprecated Not used. Can be set to null. Never implemented. Not marked
+ * as deprecated with _deprecated_argument() as it conflicts with
+ * wp_transition_post_status() and the default filter for
+ * {@see _future_post_hook()}.
+ * @param WP_Post $post Post object.
</ins><span class="cx"> */
</span><span class="cx"> function _future_post_hook( $deprecated, $post ) {
</span><span class="cx"> wp_clear_scheduled_hook( 'publish_future_post', array( $post->ID ) );
</span><span class="lines">@@ -5626,13 +5646,14 @@
</span><span class="cx"> /**
</span><span class="cx"> * Hook to schedule pings and enclosures when a post is published.
</span><span class="cx"> *
</span><ins>+ * Uses XMLRPC_REQUEST and WP_IMPORTING constants.
+ *
</ins><span class="cx"> * @since 2.3.0
</span><span class="cx"> * @access private
</span><del>- * @uses XMLRPC_REQUEST and WP_IMPORTING constants.
</del><span class="cx"> *
</span><del>- * @param int $post_id The ID in the database table of the post being published
</del><ins>+ * @param int $post_id The ID in the database table of the post being published.
</ins><span class="cx"> */
</span><del>-function _publish_post_hook($post_id) {
</del><ins>+function _publish_post_hook( $post_id ) {
</ins><span class="cx"> if ( defined( 'XMLRPC_REQUEST' ) ) {
</span><span class="cx"> /**
</span><span class="cx"> * Fires when _publish_post_hook() is called during an XML-RPC request.
</span><span class="lines">@@ -5655,13 +5676,13 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Returns the post's parent's post_ID
</del><ins>+ * Return the post's parent's post_ID
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.1.0
</span><span class="cx"> *
</span><span class="cx"> * @param int $post_id
</span><span class="cx"> *
</span><del>- * @return int|bool false on error
</del><ins>+ * @return int|bool Post parent ID, otherwise false.
</ins><span class="cx"> */
</span><span class="cx"> function wp_get_post_parent_id( $post_ID ) {
</span><span class="cx"> $post = get_post( $post_ID );
</span><span class="lines">@@ -5671,18 +5692,18 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Checks the given subset of the post hierarchy for hierarchy loops.
- * Prevents loops from forming and breaks those that it finds.
</del><ins>+ * Check the given subset of the post hierarchy for hierarchy loops.
</ins><span class="cx"> *
</span><del>- * Attached to the wp_insert_post_parent filter.
</del><ins>+ * Prevents loops from forming and breaks those that it finds. Attached
+ * to the 'wp_insert_post_parent' filter.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.1.0
</span><del>- * @uses wp_find_hierarchy_loop()
</del><span class="cx"> *
</span><ins>+ * @see wp_find_hierarchy_loop()
+ *
</ins><span class="cx"> * @param int $post_parent ID of the parent for the post we're checking.
</span><del>- * @param int $post_ID ID of the post we're checking.
- *
- * @return int The new post_parent for the post.
</del><ins>+ * @param int $post_ID ID of the post we're checking.
+ * @return int The new post_parent for the post, 0 otherwise.
</ins><span class="cx"> */
</span><span class="cx"> function wp_check_post_hierarchy_for_loops( $post_parent, $post_ID ) {
</span><span class="cx"> // Nothing fancy here - bail
</span><span class="lines">@@ -5714,12 +5735,12 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Sets a post thumbnail.
</del><ins>+ * Set a post thumbnail.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.1.0
</span><span class="cx"> *
</span><del>- * @param int|WP_Post $post Post ID or post object where thumbnail should be attached.
- * @param int $thumbnail_id Thumbnail to attach.
</del><ins>+ * @param int|WP_Post $post Post ID or post object where thumbnail should be attached.
+ * @param int $thumbnail_id Thumbnail to attach.
</ins><span class="cx"> * @return bool True on success, false on failure.
</span><span class="cx"> */
</span><span class="cx"> function set_post_thumbnail( $post, $thumbnail_id ) {
</span><span class="lines">@@ -5735,7 +5756,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Removes a post thumbnail.
</del><ins>+ * Remove a post thumbnail.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.3.0
</span><span class="cx"> *
</span><span class="lines">@@ -5750,27 +5771,32 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Deletes auto-drafts for new posts that are > 7 days old
</del><ins>+ * Delete auto-drafts for new posts that are > 7 days old.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.4.0
</span><ins>+ *
+ * @global wpdb $wpdb WordPress database access abstraction object.
</ins><span class="cx"> */
</span><span class="cx"> function wp_delete_auto_drafts() {
</span><span class="cx"> global $wpdb;
</span><span class="cx">
</span><del>- // Cleanup old auto-drafts more than 7 days old
</del><ins>+ // Cleanup old auto-drafts more than 7 days old.
</ins><span class="cx"> $old_posts = $wpdb->get_col( "SELECT ID FROM $wpdb->posts WHERE post_status = 'auto-draft' AND DATE_SUB( NOW(), INTERVAL 7 DAY ) > post_date" );
</span><del>- foreach ( (array) $old_posts as $delete )
- wp_delete_post( $delete, true ); // Force delete
</del><ins>+ foreach ( (array) $old_posts as $delete ) {
+ // Force delete.
+ wp_delete_post( $delete, true );
+ }
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * Update the custom taxonomies' term counts when a post's status is changed. For example, default posts term counts (for custom taxonomies) don't include private / draft posts.
</span><span class="cx"> *
</span><ins>+ * @since 3.3.0
</ins><span class="cx"> * @access private
</span><del>- * @param string $new_status
- * @param string $old_status
- * @param object $post
- * @since 3.3.0
</del><ins>+ *
+ * @param string $new_status New post status.
+ * @param string $old_status Old post status.
+ * @param WP_Post $post Post object.
</ins><span class="cx"> */
</span><span class="cx"> function _update_term_count_on_transition_post_status( $new_status, $old_status, $post ) {
</span><span class="cx"> // Update counts for the post's terms.
</span><span class="lines">@@ -5787,9 +5813,9 @@
</span><span class="cx"> *
</span><span class="cx"> * @access private
</span><span class="cx"> *
</span><del>- * @param array $post_ids ID list
- * @param bool $update_term_cache Whether to update the term cache. Default is true.
- * @param bool $update_meta_cache Whether to update the meta cache. Default is true.
</del><ins>+ * @param array $post_ids ID list
+ * @param bool $update_term_cache Optional. Whether to update the term cache. Default true.
+ * @param bool $update_meta_cache Optional. Whether to update the meta cache. Default true.
</ins><span class="cx"> */
</span><span class="cx"> function _prime_post_caches( $ids, $update_term_cache = true, $update_meta_cache = true ) {
</span><span class="cx"> global $wpdb;
</span><span class="lines">@@ -5801,5 +5827,3 @@
</span><span class="cx"> update_post_caches( $fresh_posts, 'any', $update_term_cache, $update_meta_cache );
</span><span class="cx"> }
</span><span class="cx"> }
</span><del>-
-
</del></span></pre>
</div>
</div>
</body>
</html>