Changeset 27699

Timestamp:

03/25/2014 08:59:55 AM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-includes/revision.php.

Props adamsilverstein, DrewAPicture.
Fixes #26979.

File:

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

trunk/src/wp-includes/revision.php

@@ -16 +16 @@
  * @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.
@@ -34 +32 @@
         );
 
-        // Runs only once
+        /**
+         * Filter the list of fields saved in post revisions.
+         *
+         * Included by default: 'post_title', 'post_content' and 'post_excerpt'.
+         *
+         * Disallowed fields: 'ID', 'post_name', 'post_parent', 'post_date',
+         * 'post_date_gmt', 'post_status', 'post_type', 'comment_count',
+         * and 'post_author'.
+         *
+         * @since 2.6.0
+         *
+         * @param array $fields List of fields to revision. Contains 'post_title',
+         *                      'post_content', and 'post_excerpt' by default.
+         */
         $fields = apply_filters( '_wp_post_revision_fields', $fields );
 
@@ -100 +111 @@
         }
 
-        if ( isset( $last_revision ) && apply_filters( 'wp_save_post_revision_check_for_changes', true, $last_revision, $post ) ) {
+        /**
+         * Filter whether the post has changed since the last revision.
+         *
+         * By default a revision is saved only if one of the revisioned fields has changed.
+         * This filter can override that so a revision is saved even if nothing has changed.
+         *
+         * @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.
+         *
+         */
+        if ( isset( $last_revision ) && apply_filters( 'wp_save_post_revision_check_for_changes', $check_for_changes = true, $last_revision, $post ) ) {
             $post_has_changed = false;
 
@@ -238 +263 @@
         return $revision_id;
 
-    if ( $revision_id )
+    if ( $revision_id ) {
+        /**
+         * Fires once a revision has been saved.
+         *
+         * @since 2.6.0
+         *
+         * @param int $revision_id Post revision ID.
+         */
         do_action( '_wp_put_post_revision', $revision_id );
+    }
 
     return $revision_id;
@@ -284 +317 @@
  * @uses wp_get_post_revision()
  * @uses wp_update_post()
- * @uses do_action() Calls 'wp_restore_post_revision' on post ID and revision ID if wp_update_post()
- *  is successful.
  *
  * @param int|object $revision_id Revision ID or revision object.
@@ -325 +356 @@
     update_post_meta( $post_id, '_edit_last', get_current_user_id() );
 
+    /**
+     * Fires after a post revision has been restored.
+     *
+     * @since 2.6.0
+     *
+     * @param int $post_id     Post ID.
+     * @param int $revision_id Post revision ID.
+     */
     do_action( 'wp_restore_post_revision', $post_id, $revision['ID'] );
 
@@ -351 +390 @@
         return $delete;
 
-    if ( $delete )
+    if ( $delete ) {
+        /**
+         * Fires once a post revision has been deleted.
+         *
+         * @since 2.6.0
+         *
+         * @param int          $revision_id Post revision ID.
+         * @param object|array $revision    Post revision object or array.
+         */
         do_action( 'wp_delete_post_revision', $revision->ID, $revision );
+    }
 
     return $delete;
@@ -407 +455 @@
  *
  * @uses post_type_supports()
- * @uses apply_filters() Calls 'wp_revisions_to_keep' hook on the number of revisions.
  *
  * @param object $post The post object.
@@ -423 +470 @@
         $num = 0;
 
+    /**
+     * Filter the number of revisions to save for the given post.
+     *
+     * Overrides the value of WP_POST_REVISIONS.
+     *
+     * @since 3.6.0
+     *
+     * @param int     $num  Number of revisions to store.
+     * @param WP_Post $post Post object.
+     */
     return (int) apply_filters( 'wp_revisions_to_keep', $num, $post );
 }