Ticket #24265: 24265.diff

wp-includes/revision.php

@@ -13 +13 @@
  * to be inserted into the posts table as a post revision. Otherwise, returns
  * an array whose keys are the post fields to be saved for post revisions.
  *
- * @package WordPress
- * @subpackage Post_Revisions
  * @since 2.6.0
  * @access private
+ *
  * @uses apply_filters() Calls '_wp_post_revision_fields' on 'title', 'content' and 'excerpt' fields.
  *
  * @param array $post Optional a post array to be processed for insertion as a post revision.
@@ -64 +63 @@
  *
  * @since 3.6
  * @access private
+ *
  * @return array An array of meta keys that should be revisioned.
  */
 function _wp_post_revision_meta_keys() {
@@ -85 +85 @@
  * Typically used immediately after post updates.
  * Adds a copy of the current post as a revision, so latest revision always matches current post
  *
- * @package WordPress
- * @subpackage Post_Revisions
  * @since 2.6.0
  *
  * @uses _wp_put_post_revision()
@@ -184 +182 @@
  * specified post. If the optional $user_id is passed, returns the autosave for that user
  * otherwise returns the latest autosave.
  *
- * @package WordPress
- * @subpackage Post_Revisions
  * @since 2.6.0
+ *
  * @uses wp_get_post_revisions()
  *
  * @param int $post_id The post ID.
@@ -212 +209 @@
 /**
  * Determines if the specified post is a revision.
  *
- * @package WordPress
- * @subpackage Post_Revisions
  * @since 2.6.0
  *
  * @param int|object $post Post ID or post object.
@@ -229 +224 @@
 /**
  * Determines if the specified post is an autosave.
  *
- * @package WordPress
- * @subpackage Post_Revisions
  * @since 2.6.0
  *
  * @param int|object $post Post ID or post object.
@@ -249 +242 @@
 /**
  * Inserts post data into the posts table as a post revision.
  *
- * @package WordPress
- * @subpackage Post_Revisions
  * @since 2.6.0
+ * @access private
  *
  * @uses wp_insert_post()
  *
@@ -303 +295 @@
 /**
  * Gets a post revision.
  *
- * @package WordPress
- * @subpackage Post_Revisions
  * @since 2.6.0
  *
  * @uses get_post()
  *
- * @param int|object $post Post ID or post object
+ * @param int|object $post The post ID or object.
  * @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N.
- * @param string $filter Optional sanitation filter. @see sanitize_post()
- * @return mixed Null if error or post object if success
+ * @param string $filter Optional sanitation filter. @see sanitize_post().
+ * @return mixed Null if error or post object if success.
  */
 function wp_get_post_revision(&$post, $output = OBJECT, $filter = 'raw') {
         $null = null;
@@ -339 +329 @@
  *
  * Can restore a past revision using all fields of the post revision, or only selected fields.
  *
- * @package WordPress
- * @subpackage Post_Revisions
  * @since 2.6.0
  *
  * @uses wp_get_post_revision()
@@ -405 +393 @@
  *
  * Deletes the row from the posts table corresponding to the specified revision.
  *
- * @package WordPress
- * @subpackage Post_Revisions
  * @since 2.6.0
  *
  * @uses wp_get_post_revision()
@@ -432 +418 @@
 /**
  * Returns all revisions of specified post.
  *
- * @package WordPress
- * @subpackage Post_Revisions
  * @since 2.6.0
  *
  * @uses get_children()
  *
  * @param int|object $post_id Post ID or post object
- * @return array empty if no revisions
+ * @return array An array of revisions, or an empty array if none.
  */
 function wp_get_post_revisions( $post_id = 0, $args = null ) {
         $post = get_post( $post_id );
@@ -463 +447 @@
  *
  * @uses wp_revisions_to_keep()
  *
- * @param object $post
- * @return bool
+ * @param object $post The post object.
+ * @return bool True if number of revisions to keep isn't zero, false otherwise.
  */
 function wp_revisions_enabled( $post ) {
         return wp_revisions_to_keep( $post ) != 0;
@@ -479 +463 @@
  * @uses post_type_supports()
  * @uses apply_filters() Calls 'wp_revisions_to_keep' hook on the number of revisions.
  *
- * @param object $post
- * @return int
+ * @param object $post The post object.
+ * @return int The number of revisions to keep.
  */
 function wp_revisions_to_keep( $post ) {
         $num = WP_POST_REVISIONS;
@@ -496 +480 @@
         return (int) apply_filters( 'wp_revisions_to_keep', $num, $post );
 }
 
+/**
+ * Sets up the post object for preview based on the post autosave.
+ *
+ * @since 2.7.0
+ * @access private
+ */
 function _set_preview($post) {
 
         if ( ! is_object($post) )
@@ -518 +508 @@
         return $post;
 }
 
+/**
+ * Filters the latest content for preview from the post autosave.
+ *
+ * @since 2.7.0
+ * @access private
+ */
 function _show_post_preview() {
 
         if ( isset($_GET['preview_id']) && isset($_GET['preview_nonce']) ) {
@@ -573 +569 @@
         return $terms;
 }
 
+/**
+ * Gets the post revision version.
+ *
+ * @since 3.6.0
+ * @access private
+*/
 function _wp_get_post_revision_version( $revision ) {
         if ( is_object( $revision ) )
                 $revision = get_object_vars( $revision );
@@ -588 +590 @@
 /**
  * Upgrade the revisions author, add the current post as a revision and set the revisions version to 1
  *
- * @package WordPress
- * @subpackage Post_Revisions
  * @since 3.6.0
+ * @access private
  *
  * @uses wp_get_post_revisions()
  *
@@ -683 +684 @@
  * similar to wp_text_diff, but tracks and returns could of lines added and removed
  *
  * @since 3.6.0
+ *
  * @see wp_parse_args() Used to change defaults to user defined settings.
  * @uses Text_Diff
  * @uses WP_Text_Diff_Renderer_Table