Changeset 47122 for trunk/src/wp-includes/revision.php

Timestamp:

01/29/2020 12:43:23 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/src/wp-includes/revision.php (modified) (13 diffs)

trunk/src/wp-includes/revision.php

@@ -30 +30 @@
 
     if ( is_null( $fields ) ) {
-        // Allow these to be versioned
+        // Allow these to be versioned.
         $fields = array(
             'post_title'   => __( 'Title' ),
@@ -56 +56 @@
     $fields = apply_filters( '_wp_post_revision_fields', $fields, $post );
 
-    // WP uses these internally either in versioning or elsewhere - they cannot be versioned
+    // WP uses these internally either in versioning or elsewhere - they cannot be versioned.
     foreach ( array( 'ID', 'post_name', 'post_parent', 'post_date', 'post_date_gmt', 'post_status', 'post_type', 'comment_count', 'post_author' ) as $protect ) {
         unset( $fields[ $protect ] );
@@ -91 +91 @@
     $revision_data['post_status']   = 'inherit';
     $revision_data['post_type']     = 'revision';
-    $revision_data['post_name']     = $autosave ? "$post[ID]-autosave-v1" : "$post[ID]-revision-v1"; // "1" is the revisioning system version
+    $revision_data['post_name']     = $autosave ? "$post[ID]-autosave-v1" : "$post[ID]-revision-v1"; // "1" is the revisioning system version.
     $revision_data['post_date']     = isset( $post['post_modified'] ) ? $post['post_modified'] : '';
     $revision_data['post_date_gmt'] = isset( $post['post_modified_gmt'] ) ? $post['post_modified_gmt'] : '';
@@ -131 +131 @@
     }
 
-    // Compare the proposed update with the last stored revision verifying that
-    // they are different, unless a plugin tells us to always save regardless.
-    // If no previous revisions, save one
+    /*
+     * Compare the proposed update with the last stored revision verifying that
+     * they are different, unless a plugin tells us to always save regardless.
+     * If no previous revisions, save one.
+     */
     $revisions = wp_get_post_revisions( $post_id );
     if ( $revisions ) {
-        // grab the last revision, but not an autosave
+        // Grab the last revision, but not an autosave.
         foreach ( $revisions as $revision ) {
             if ( false !== strpos( $revision->post_name, "{$revision->post_parent}-revision" ) ) {
@@ -181 +183 @@
             $post_has_changed = (bool) apply_filters( 'wp_save_post_revision_post_has_changed', $post_has_changed, $last_revision, $post );
 
-            //don't save revision if post unchanged
+            // Don't save revision if post unchanged.
             if ( ! $post_has_changed ) {
                 return;
@@ -312 +314 @@
 
     $post = _wp_post_revision_data( $post, $autosave );
-    $post = wp_slash( $post ); //since data is from db
+    $post = wp_slash( $post ); // Since data is from DB.
 
     $revision_id = wp_insert_post( $post );
@@ -398 +400 @@
     $update['ID'] = $revision['post_parent'];
 
-    $update = wp_slash( $update ); //since data is from db
+    $update = wp_slash( $update ); // Since data is from DB.
 
     $post_id = wp_update_post( $update );
@@ -405 +407 @@
     }
 
-    // Update last edit user
+    // Update last edit user.
     update_post_meta( $post_id, '_edit_last', get_current_user_id() );
 
@@ -624 +626 @@
         $term = get_term_by( 'slug', 'post-format-' . sanitize_key( $_REQUEST['post_format'] ), 'post_format' );
         if ( $term ) {
-            $terms = array( $term ); // Can only have one post format
+            $terms = array( $term ); // Can only have one post format.
         }
     }
@@ -704 +706 @@
     global $wpdb;
 
-    // Add post option exclusively
+    // Add post option exclusively.
     $lock   = "revision-upgrade-{$post->ID}";
     $now    = time();
     $result = $wpdb->query( $wpdb->prepare( "INSERT IGNORE INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, 'no') /* LOCK */", $lock, $now ) );
     if ( ! $result ) {
-        // If we couldn't get a lock, see how old the previous lock is
+        // If we couldn't get a lock, see how old the previous lock is.
         $locked = get_option( $lock );
         if ( ! $locked ) {
             // Can't write to the lock, and can't read the lock.
-            // Something broken has happened
+            // Something broken has happened.
             return false;
         }
 
         if ( $locked > $now - 3600 ) {
-            // Lock is not too old: some other process may be upgrading this post.  Bail.
+            // Lock is not too old: some other process may be upgrading this post. Bail.
             return false;
         }
 
-        // Lock is too old - update it (below) and continue
+        // Lock is too old - update it (below) and continue.
     }
 
@@ -737 +739 @@
         $this_revision_version = _wp_get_post_revision_version( $this_revision );
 
-        // Something terrible happened
+        // Something terrible happened.
         if ( false === $this_revision_version ) {
             continue;
@@ -749 +751 @@
         }
 
-        // Always update the revision version
+        // Always update the revision version.
         $update = array(
             'post_name' => preg_replace( '/^(\d+-(?:autosave|revision))[\d-]*$/', '$1-v1', $this_revision->post_name ),
         );
 
-        // If this revision is the oldest revision of the post, i.e. no $prev_revision,
-        // the correct post_author is probably $post->post_author, but that's only a good guess.
-        // Update the revision version only and Leave the author as-is.
+        /*
+         * If this revision is the oldest revision of the post, i.e. no $prev_revision,
+         * the correct post_author is probably $post->post_author, but that's only a good guess.
+         * Update the revision version only and Leave the author as-is.
+         */
         if ( $prev_revision ) {
             $prev_revision_version = _wp_get_post_revision_version( $prev_revision );
@@ -766 +770 @@
         }
 
-        // Upgrade this revision
+        // Upgrade this revision.
         $result = $wpdb->update( $wpdb->posts, $update, array( 'ID' => $this_revision->ID ) );