Changeset 29097

Timestamp:

07/11/2014 06:34:36 PM (11 years ago)

Author:

DrewAPicture

Message:

Fix syntax for inline comment line endings and a few line wraps in wp-includes/post.php inline documentation.

Fixes #25412.

File:

• trunk/src/wp-includes/post.php (modified) (31 diffs)

trunk/src/wp-includes/post.php

@@ -392 +392 @@
     }
 
-    // ` leading and trailing whitespace
+    //  leading and trailing whitespace.
     $main = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $main);
     $extended = preg_replace('/^[\s]*(.*)[\s]*$/', '\\1', $extended);
@@ -872 +872 @@
             return 'private';
 
-        // Unattached attachments are assumed to be published
+        // Unattached attachments are assumed to be published.
         if ( ( 'inherit' == $post->post_status ) && ( 0 == $post->post_parent) )
             return 'publish';
 
-        // Inherit status from the parent
+        // Inherit status from the parent.
         if ( $post->post_parent && ( $post->ID != $post->post_parent ) ) {
             $parent_post_status = get_post_status( $post->post_parent );
@@ -1363 +1363 @@
         $args->exclude_from_search = !$args->public;
 
-    // Back compat with quirky handling in version 3.0. #14122
+    // Back compat with quirky handling in version 3.0. #14122.
     if ( empty( $args->capabilities ) && null === $args->map_meta_cap && in_array( $args->capability_type, array( 'post', 'page' ) ) )
         $args->map_meta_cap = true;
@@ -1697 +1697 @@
     foreach ( get_post_types( array( 'show_ui' => true ) ) as $ptype ) {
         $ptype_obj = get_post_type_object( $ptype );
-        // Submenus only.
+        // Sub-menus only.
         if ( ! $ptype_obj->show_in_menu || $ptype_obj->show_in_menu === true )
             continue;
@@ -1949 +1949 @@
  */
 function update_post_meta( $post_id, $meta_key, $meta_value, $prev_value = '' ) {
-    // make sure meta is added to the post, not a revision
+    // Make sure meta is added to the post, not a revision.
     if ( $the_post = wp_is_post_revision($post_id) )
         $post_id = $the_post;
@@ -2592 +2592 @@
 
     if ( is_post_type_hierarchical( $post->post_type ) ) {
-        // Point children of this page to its parent, also clean the cache of affected children
+        // Point children of this page to its parent, also clean the cache of affected children.
         $children_query = $wpdb->prepare( "SELECT * FROM $wpdb->posts WHERE post_parent = %d AND post_type = %s", $postid, $post->post_type );
         $children = $wpdb->get_results( $children_query );
@@ -2599 +2599 @@
     }
 
-    // Do raw query. wp_get_post_revisions() is filtered
+    // Do raw query. wp_get_post_revisions() is filtered.
     $revision_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'revision'", $postid ) );
     // Use wp_delete_post (via wp_delete_post_revision) again. Ensures any meta/misplaced data gets cleaned up.
@@ -2605 +2605 @@
         wp_delete_post_revision( $revision_id );
 
-    // Point all attachments to this post up one level
+    // Point all attachments to this post up one level.
     $wpdb->update( $wpdb->posts, $parent_data, $parent_where + array( 'post_type' => 'attachment' ) );
 
@@ -2675 +2675 @@
     $post = get_post( $post_id );
     if ( 'page' == $post->post_type ) {
-        // If the page is defined in option page_on_front or post_for_posts,
-        // adjust the corresponding options
+        /*
+         * If the page is defined in option page_on_front or post_for_posts,
+         * adjust the corresponding options.
+         */
         if ( get_option( 'page_on_front' ) == $post->ID ) {
             update_option( 'show_on_front', 'posts' );
@@ -2821 +2823 @@
         return;
 
-    // Cache current status for each comment
+    // Cache current status for each comment.
     $statuses = array();
     foreach ( $comments as $comment )
@@ -2827 +2829 @@
     add_post_meta($post_id, '_wp_trash_meta_comments_status', $statuses);
 
-    // Set status for all comments to post-trashed
+    // Set status for all comments to post-trashed.
     $result = $wpdb->update($wpdb->comments, array('comment_approved' => 'post-trashed'), array('comment_post_ID' => $post_id));
 
@@ -2876 +2878 @@
     do_action( 'untrash_post_comments', $post_id );
 
-    // Restore each comment to its original status
+    // Restore each comment to its original status.
     $group_by_status = array();
     foreach ( $statuses as $comment_id => $comment_status )
@@ -2995 +2997 @@
     }
 
-    // Set default arguments
+    // Set default arguments.
     $defaults = array(
         'numberposts' => 10, 'offset' => 0,
@@ -3009 +3011 @@
     $results = get_posts( $r );
 
-    // Backward compatibility. Prior to 3.1 expected posts to be returned in array
+    // Backward compatibility. Prior to 3.1 expected posts to be returned in array.
     if ( ARRAY_A == $output ){
         foreach( $results as $key => $result ) {
@@ -3527 +3529 @@
 function wp_update_post( $postarr = array(), $wp_error = false ) {
     if ( is_object($postarr) ) {
-        // non-escaped post was passed
+        // Non-escaped post was passed.
         $postarr = get_object_vars($postarr);
         $postarr = wp_slash($postarr);
@@ -3635 +3637 @@
     $time = strtotime( $post->post_date_gmt . ' GMT' );
 
-    if ( $time > time() ) { // Uh oh, someone jumped the gun!
+    // Uh oh, someone jumped the gun!
+    if ( $time > time() ) {
         wp_clear_scheduled_hook( 'publish_future_post', array( $post_id ) ); // clear anything else in the system
         wp_schedule_single_event( $time, 'publish_future_post', array( $post_id ) );
@@ -3989 +3992 @@
     $new = apply_filters( 'add_ping', $new );
 
-    // expected_slashed ($new)
+    // expected_slashed ($new).
     $new = wp_unslash($new);
     return $wpdb->update( $wpdb->posts, array( 'pinged' => $new ), array( 'ID' => $post_id ) );
@@ -4093 +4096 @@
 function trackback_url_list( $tb_list, $post_id ) {
     if ( ! empty( $tb_list ) ) {
-        // get post data
+        // Get post data.
         $postdata = get_post( $post_id, ARRAY_A );
 
-        // form an excerpt
+        // Form an excerpt.
         $excerpt = strip_tags( $postdata['post_excerpt'] ? $postdata['post_excerpt'] : $postdata['post_content'] );
 
@@ -4432 +4435 @@
     $post_status = $r['post_status'];
 
-    // Make sure the post type is hierarchical
+    // Make sure the post type is hierarchical.
     $hierarchical_post_types = get_post_types( array( 'hierarchical' => true ) );
     if ( ! in_array( $r['post_type'], $hierarchical_post_types ) ) {
@@ -4442 +4445 @@
     }
 
-    // Make sure we have a valid post status
+    // Make sure we have a valid post status.
     if ( ! is_array( $post_status ) ) {
         $post_status = explode( ',', $post_status );
@@ -4450 +4453 @@
     }
 
-    // $args can be whatever, only use the args defined in defaults to compute the key
+    // $args can be whatever, only use the args defined in defaults to compute the key.
     $key = md5( serialize( wp_array_slice_assoc( $r, array_keys( $defaults ) ) ) );
     $last_changed = wp_cache_get( 'last_changed', 'posts' );
@@ -4460 +4463 @@
     $cache_key = "get_pages:$key:$last_changed";
     if ( $cache = wp_cache_get( $cache_key, 'posts' ) ) {
-        // Convert to WP_Post instances
+        // Convert to WP_Post instances.
         $pages = array_map( 'get_post', $cache );
         /** This filter is documented in wp-includes/post.php */
@@ -4609 +4612 @@
     }
 
-    // Sanitize before caching so it'll only get done once
+    // Sanitize before caching so it'll only get done once.
     $num_pages = count($pages);
     for ($i = 0; $i < $num_pages; $i++) {
@@ -4646 +4649 @@
     wp_cache_set( $cache_key, $page_structure, 'posts' );
 
-    // Convert to WP_Post instances
+    // Convert to WP_Post instances.
     $pages = array_map( 'get_post', $pages );
 
@@ -4781 +4784 @@
     wp_delete_object_term_relationships($post_id, get_object_taxonomies($post->post_type));
 
-    delete_metadata( 'post', null, '_thumbnail_id', $post_id, true ); // delete all for any posts.
+    // Delete all for any posts.
+    delete_metadata( 'post', null, '_thumbnail_id', $post_id, true );
 
     $comment_ids = $wpdb->get_col( $wpdb->prepare( "SELECT comment_ID FROM $wpdb->comments WHERE comment_post_ID = %d", $post_id ));
@@ -5273 +5277 @@
     $sql .= "(post_status = 'publish'";
 
-    // Only need to check the cap if $public_only is false
+    // Only need to check the cap if $public_only is false.
     if ( false === $public_only ) {
         if ( current_user_can( $cap ) ) {
@@ -5593 +5597 @@
 
     if ( $old_status != 'publish' && $new_status == 'publish' ) {
-        // Reset GUID if transitioning to publish and it is empty
+        // Reset GUID if transitioning to publish and it is empty.
         if ( '' == get_the_guid($post->ID) )
             $wpdb->update( $wpdb->posts, array( 'guid' => get_permalink( $post->ID ) ), array( 'ID' => $post->ID ) );
@@ -5608 +5612 @@
     }
 
-    // If published posts changed clear the lastpostmodified cache
+    // If published posts changed clear the lastpostmodified cache.
     if ( 'publish' == $new_status || 'publish' == $old_status) {
         foreach ( array( 'server', 'gmt', 'blog' ) as $timezone ) {
@@ -5707 +5711 @@
  */
 function wp_check_post_hierarchy_for_loops( $post_parent, $post_ID ) {
-    // Nothing fancy here - bail
+    // Nothing fancy here - bail.
     if ( !$post_parent )
         return 0;
 
-    // New post can't cause a loop
+    // New post can't cause a loop.
     if ( empty( $post_ID ) )
         return $post_parent;
 
-    // Can't be its own parent
+    // Can't be its own parent.
     if ( $post_parent == $post_ID )
         return 0;
 
-    // Now look for larger loops
-
+    // Now look for larger loops.
     if ( !$loop = wp_find_hierarchy_loop( 'wp_get_post_parent_id', $post_ID, $post_parent ) )
         return $post_parent; // No loop
 
-    // Setting $post_parent to the given value causes a loop
+    // Setting $post_parent to the given value causes a loop.
     if ( isset( $loop[$post_ID] ) )
         return 0;
@@ -5790 +5793 @@
 
 /**
- * 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.
+ * 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.
  *
  * @since 3.3.0
@@ -5811 +5817 @@
  *
  * @since 3.4.0
- *
  * @access private
+ *
+ * @see update_post_caches()
  *
  * @param array $post_ids          ID list