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

Timestamp:

11/01/2014 08:19:26 PM (10 years ago)

Author:

wonderboymusic

Message:

Improve some post_status-related documentation.

Props ericlewis.
See #30230.

File:

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

trunk/src/wp-includes/revision.php

@@ -71 +71 @@
 
 /**
- * Saves an already existing post as a post revision.
- *
- * Typically used immediately after post updates.
- * Adds a copy of the current post as a revision, so latest revision always matches current post
- *
- * @since 2.6.0
- *
- * @param int $post_id The ID of the post to save as a revision.
+ * Creates a revision for the current version of a post.
+ *
+ * Typically used immediately after a post update, as every update is a revision,
+ * and the most recent revision always matches the current post.
+ *
+ * @since 2.6.0
+ *
+ * @param  int   $post_id The ID of the post to save as a revision.
  * @return mixed Null or 0 if error, new revision ID, if success.
  */
@@ -157 +157 @@
     $return = _wp_put_post_revision( $post );
 
+    // If a limit for the number of revisions to keep has been set,
+    // delete the oldest ones.
     $revisions_to_keep = wp_revisions_to_keep( $post );
 
@@ -162 +164 @@
         return $return;
 
-    // all revisions and autosaves
     $revisions = wp_get_post_revisions( $post_id, array( 'order' => 'ASC' ) );
 
@@ -447 +448 @@
 /**
  * Determine how many revisions to retain for a given post.
- * By default, an infinite number of revisions are stored if a post type supports revisions.
+ *
+ * By default, an infinite number of revisions are kept.
+ *
+ * The constant WP_POST_REVISIONS can be set in wp-config to specify the limit
+ * of revisions to keep.
  *
  * @since 3.6.0
  *
- * @param object $post The post object.
+ * @param  object $post The post object.
  * @return int The number of revisions to keep.
  */