WordPress 4.4
[autoinstalls/wordpress.git] / wp-includes / revision.php
index 45e436f567bd1ca3c7bd5a3e447b4ed35070ce9f..8c2337624df1a8cd78d7641874ede06434965310 100644 (file)
  * @since 2.6.0
  * @access private
  *
- * @param array $post Optional a post array to be processed for insertion as a post revision.
- * @param bool $autosave optional Is the revision an autosave?
+ * @staticvar array $fields
+ *
+ * @param array|null $post     Optional. A post array to be processed for insertion as a post revision. Default null.
+ * @param bool       $autosave Optional. Is the revision an autosave? Default false.
  * @return array Post array ready to be inserted as a post revision or array of fields that can be versioned.
  */
 function _wp_post_revision_fields( $post = null, $autosave = false ) {
-       static $fields = false;
+       static $fields = null;
 
-       if ( !$fields ) {
+       if ( is_null( $fields ) ) {
                // Allow these to be versioned
                $fields = array(
                        'post_title' => __( 'Title' ),
@@ -70,17 +72,15 @@ function _wp_post_revision_fields( $post = null, $autosave = false ) {
 }
 
 /**
- * Saves an already existing post as a post revision.
+ * Creates a revision for the current version of a post.
  *
- * Typically used immediately after post updates.
- * Adds a copy of the current post as a revision, so latest revision always matches current 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
  *
- * @uses _wp_put_post_revision()
- *
  * @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.
+ * @return int|WP_Error|void Void or 0 if error, new revision ID, if success.
  */
 function wp_save_post_revision( $post_id ) {
        if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE )
@@ -118,10 +118,10 @@ function wp_save_post_revision( $post_id ) {
                 *
                 * @since 3.6.0
                 *
-                * @param bool $check_for_changes Whether to check for changes before saving a new revision.
-                *                                Default true.
-                * @param int  $last_revision     ID of the last revision.
-                * @param int  $post              Post ID.
+                * @param bool    $check_for_changes Whether to check for changes before saving a new revision.
+                *                                   Default true.
+                * @param WP_Post $last_revision     The the last revision post object.
+                * @param WP_Post $post              The post object.
                 *
                 */
                if ( isset( $last_revision ) && apply_filters( 'wp_save_post_revision_check_for_changes', $check_for_changes = true, $last_revision, $post ) ) {
@@ -133,20 +133,38 @@ function wp_save_post_revision( $post_id ) {
                                        break;
                                }
                        }
+
+                       /**
+                        * Filter whether a post has changed.
+                        *
+                        * By default a revision is saved only if one of the revisioned fields has changed.
+                        * This filter allows for additional checks to determine if there were changes.
+                        *
+                        * @since 4.1.0
+                        *
+                        * @param bool    $post_has_changed Whether the post has changed.
+                        * @param WP_Post $last_revision    The last revision post object.
+                        * @param WP_Post $post             The post object.
+                        *
+                        */
+                       $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
-                       if( ! $post_has_changed )
+                       if ( ! $post_has_changed ) {
                                return;
+                       }
                }
        }
 
        $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 );
 
        if ( $revisions_to_keep < 0 )
                return $return;
 
-       // all revisions and autosaves
        $revisions = wp_get_post_revisions( $post_id, array( 'order' => 'ASC' ) );
 
        $delete = count($revisions) - $revisions_to_keep;
@@ -175,11 +193,9 @@ function wp_save_post_revision( $post_id ) {
  *
  * @since 2.6.0
  *
- * @uses wp_get_post_revisions()
- *
  * @param int $post_id The post ID.
- * @param int $user_id optional The post author ID.
- * @return object|bool The autosaved data or false on failure or when no autosave exists.
+ * @param int $user_id Optional The post author ID.
+ * @return WP_Post|false The autosaved data or false on failure or when no autosave exists.
  */
 function wp_get_post_autosave( $post_id, $user_id = 0 ) {
        $revisions = wp_get_post_revisions( $post_id, array( 'check_enabled' => false ) );
@@ -201,8 +217,8 @@ function wp_get_post_autosave( $post_id, $user_id = 0 ) {
  *
  * @since 2.6.0
  *
- * @param int|object $post Post ID or post object.
- * @return bool|int False if not a revision, ID of revision's parent otherwise.
+ * @param int|WP_Post $post Post ID or post object.
+ * @return false|int False if not a revision, ID of revision's parent otherwise.
  */
 function wp_is_post_revision( $post ) {
        if ( !$post = wp_get_post_revision( $post ) )
@@ -216,8 +232,8 @@ function wp_is_post_revision( $post ) {
  *
  * @since 2.6.0
  *
- * @param int|object $post Post ID or post object.
- * @return bool|int False if not a revision, ID of autosave's parent otherwise
+ * @param int|WP_Post $post Post ID or post object.
+ * @return false|int False if not a revision, ID of autosave's parent otherwise
  */
 function wp_is_post_autosave( $post ) {
        if ( !$post = wp_get_post_revision( $post ) )
@@ -235,11 +251,9 @@ function wp_is_post_autosave( $post ) {
  * @since 2.6.0
  * @access private
  *
- * @uses wp_insert_post()
- *
- * @param int|object|array $post Post ID, post object OR post array.
- * @param bool $autosave Optional. Is the revision an autosave?
- * @return mixed WP_Error or 0 if error, new revision ID if success.
+ * @param int|WP_Post|array|null $post     Post ID, post object OR post array.
+ * @param bool                   $autosave Optional. Is the revision an autosave?
+ * @return int|WP_Error WP_Error or 0 if error, new revision ID if success.
  */
 function _wp_put_post_revision( $post = null, $autosave = false ) {
        if ( is_object($post) )
@@ -248,7 +262,7 @@ function _wp_put_post_revision( $post = null, $autosave = false ) {
                $post = get_post($post, ARRAY_A);
 
        if ( ! $post || empty($post['ID']) )
-               return new WP_Error( 'invalid_post', __( 'Invalid post ID' ) );
+               return new WP_Error( 'invalid_post', __( 'Invalid post ID.' ) );
 
        if ( isset($post['post_type']) && 'revision' == $post['post_type'] )
                return new WP_Error( 'post_type', __( 'Cannot create a revision of a revision' ) );
@@ -279,12 +293,10 @@ function _wp_put_post_revision( $post = null, $autosave = false ) {
  *
  * @since 2.6.0
  *
- * @uses get_post()
- *
- * @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 int|WP_Post $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 WP_Post|array|null Null if error or post object if success.
  */
 function wp_get_post_revision(&$post, $output = OBJECT, $filter = 'raw') {
        if ( !$revision = get_post( $post, OBJECT, $filter ) )
@@ -312,12 +324,9 @@ function wp_get_post_revision(&$post, $output = OBJECT, $filter = 'raw') {
  *
  * @since 2.6.0
  *
- * @uses wp_get_post_revision()
- * @uses wp_update_post()
- *
- * @param int|object $revision_id Revision ID or revision object.
- * @param array $fields Optional. What fields to restore from. Defaults to all.
- * @return mixed Null if error, false if no fields to restore, (int) post ID if success.
+ * @param int|WP_Post $revision_id Revision ID or revision object.
+ * @param array       $fields      Optional. What fields to restore from. Defaults to all.
+ * @return int|false|null Null if error, false if no fields to restore, (int) post ID if success.
  */
 function wp_restore_post_revision( $revision_id, $fields = null ) {
        if ( !$revision = wp_get_post_revision( $revision_id, ARRAY_A ) )
@@ -327,7 +336,7 @@ function wp_restore_post_revision( $revision_id, $fields = null ) {
                $fields = array_keys( _wp_post_revision_fields() );
 
        $update = array();
-       foreach( array_intersect( array_keys( $revision ), $fields ) as $field ) {
+       foreach ( array_intersect( array_keys( $revision ), $fields ) as $field ) {
                $update[$field] = $revision[$field];
        }
 
@@ -373,20 +382,15 @@ function wp_restore_post_revision( $revision_id, $fields = null ) {
  *
  * @since 2.6.0
  *
- * @uses wp_get_post_revision()
- * @uses wp_delete_post()
- *
- * @param int|object $revision_id Revision ID or revision object.
- * @return mixed Null or WP_Error if error, deleted post if success.
+ * @param int|WP_Post $revision_id Revision ID or revision object.
+ * @return array|false|WP_Post|WP_Error|null Null or WP_Error if error, deleted post if success.
  */
 function wp_delete_post_revision( $revision_id ) {
-       if ( !$revision = wp_get_post_revision( $revision_id ) )
+       if ( ! $revision = wp_get_post_revision( $revision_id ) ) {
                return $revision;
+       }
 
        $delete = wp_delete_post( $revision->ID );
-       if ( is_wp_error( $delete ) )
-               return $delete;
-
        if ( $delete ) {
                /**
                 * Fires once a post revision has been deleted.
@@ -407,8 +411,6 @@ function wp_delete_post_revision( $revision_id ) {
  *
  * @since 2.6.0
  *
- * @uses get_children()
- *
  * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
  * @return array An array of revisions, or an empty array if none.
  */
@@ -436,24 +438,24 @@ function wp_get_post_revisions( $post_id = 0, $args = null ) {
  *
  * @since 3.6.0
  *
- * @uses wp_revisions_to_keep()
- *
- * @param object $post The post object.
+ * @param WP_Post $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;
+       return wp_revisions_to_keep( $post ) !== 0;
 }
 
 /**
  * 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.
  *
- * @since 3.6.0
+ * By default, an infinite number of revisions are kept.
  *
- * @uses post_type_supports()
+ * 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 WP_Post $post The post object.
  * @return int The number of revisions to keep.
  */
 function wp_revisions_to_keep( $post ) {
@@ -485,18 +487,21 @@ function wp_revisions_to_keep( $post ) {
  *
  * @since 2.7.0
  * @access private
+ *
+ * @param WP_Post $post
+ * @return WP_Post|false
  */
-function _set_preview($post) {
-
-       if ( ! is_object($post) )
+function _set_preview( $post ) {
+       if ( ! is_object( $post ) ) {
                return $post;
+       }
 
-       $preview = wp_get_post_autosave($post->ID);
-
-       if ( ! is_object($preview) )
+       $preview = wp_get_post_autosave( $post->ID );
+       if ( ! is_object( $preview ) ) {
                return $post;
+       }
 
-       $preview = sanitize_post($preview);
+       $preview = sanitize_post( $preview );
 
        $post->post_content = $preview->post_content;
        $post->post_title = $preview->post_title;
@@ -514,11 +519,10 @@ function _set_preview($post) {
  * @access private
  */
 function _show_post_preview() {
-
        if ( isset($_GET['preview_id']) && isset($_GET['preview_nonce']) ) {
                $id = (int) $_GET['preview_id'];
 
-               if ( false == wp_verify_nonce( $_GET['preview_nonce'], 'post_preview_' . $id ) )
+               if ( false === wp_verify_nonce( $_GET['preview_nonce'], 'post_preview_' . $id ) )
                        wp_die( __('You do not have permission to preview drafts.') );
 
                add_filter('the_preview', '_set_preview');
@@ -530,6 +534,11 @@ function _show_post_preview() {
  *
  * @since 3.6.0
  * @access private
+ *
+ * @param array  $terms
+ * @param int    $post_id
+ * @param string $taxonomy
+ * @return array
  */
 function _wp_preview_terms_filter( $terms, $post_id, $taxonomy ) {
        if ( ! $post = get_post() )
@@ -551,7 +560,10 @@ function _wp_preview_terms_filter( $terms, $post_id, $taxonomy ) {
  *
  * @since 3.6.0
  * @access private
-*/
+ *
+ * @param WP_Post $revision
+ * @return int|false
+ */
 function _wp_get_post_revision_version( $revision ) {
        if ( is_object( $revision ) )
                $revision = get_object_vars( $revision );
@@ -570,10 +582,10 @@ function _wp_get_post_revision_version( $revision ) {
  * @since 3.6.0
  * @access private
  *
- * @uses wp_get_post_revisions()
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param object $post Post object
- * @param array $revisions Current revisions of the post
+ * @param WP_Post $post      Post object
+ * @param array   $revisions Current revisions of the post
  * @return bool true if the revisions were upgraded, false if problems
  */
 function _wp_upgrade_revisions_of_post( $post, $revisions ) {