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

Timestamp:

09/26/2023 03:30:34 PM (22 months ago)

Author:

adamsilverstein

Message:

Revisions: framework for storing post meta revisions.

Enable the storing of post meta in revisions including autosaves and previews:

Add a new argument revisions_enabled to the register_meta function which enables storing meta in revisions.

Add a new wp_post_revision_meta_keys filter which developers can use to control which meta is revisioned - it passes an array of the meta keys with revisions enabled as well as the post type.

Meta keys with revisions enabled are also stored for autosaves, and are restored when a revision or autosave is restored. In addition, meta values are now stored with the autosave revision used for previews. Changes to meta can now be previewed correctly without overwriting the published meta (see #20299) or passing data as a query variable, as the editor currently does to preview changes to the featured image.

Changes to meta with revisions enabled are considered when determining if a new revision should be created. A new revision is created if the meta value has changed since the last revision.

Revisions are now saved on the wp_after_insert_post hook instead of post_updated. The wp_after_insert_post action is fired after post meta has been saved by the REST API which enables attaching meta to the revision. To ensure backwards compatibility with existing action uses, wp_save_post_revision_on_insert function exits early if plugins have removed the previous do_action( 'post_updated', 'wp_save_post_revision' ) call.

Props: alexkingorg, johnbillion, markjaquith, WraithKenny, kovshenin, azaozz, tv-productions, p51labs, mattheu, mikeschroder, Mamaduka, ellatrix, timothyblynjacobs, jakemgold, bookwyrm, ryanduff, mintindeed, wonderboymusic, sanchothefat, westonruter, spacedmonkey, hellofromTonya, drewapicture, adamsilverstein, swisspiddy.
Fixes #20564, #20299.

File:

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

trunk/src/wp-includes/revision.php

@@ -97 +97 @@
 
 /**
+ * Saves revisions for a post after all changes have been made.
+ *
+ * @since 6.4.0
+ *
+ * @param int     $post_id The post id that was inserted.
+ * @param WP_Post $post    The post object that was inserted.
+ * @param bool    $update  Whether this insert is updating an existing post.
+ */
+function wp_save_post_revision_on_insert( $post_id, $post, $update ) {
+    if ( ! $update ) {
+        return;
+    }
+
+    if ( ! has_action( 'post_updated', 'wp_save_post_revision' ) ) {
+        return;
+    }
+
+    wp_save_post_revision( $post_id );
+}
+
+/**
  * Creates a revision for the current version of a post.
  *
@@ -109 +130 @@
 function wp_save_post_revision( $post_id ) {
     if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) {
+        return;
+    }
+
+    // Prevent saving post revisions if revisions should be saved on wp_after_insert_post.
+    if ( doing_action( 'post_updated' ) && has_action( 'wp_after_insert_post', 'wp_save_post_revision_on_insert' ) ) {
         return;
     }
@@ -362 +388 @@
          *
          * @since 2.6.0
+         * @since 6.4.0 The post_id parameter was added.
          *
          * @param int $revision_id Post revision ID.
+         * @param int $post_id     Post ID.
          */
-        do_action( '_wp_put_post_revision', $revision_id );
+        do_action( '_wp_put_post_revision', $revision_id, $post['post_parent'] );
     }
 
     return $revision_id;
+}
+
+
+/**
+ * Save the revisioned meta fields.
+ *
+ * @since 6.4.0
+ *
+ * @param int $revision_id The ID of the revision to save the meta to.
+ * @param int $post_id     The ID of the post the revision is associated with.
+ */
+function wp_save_revisioned_meta_fields( $revision_id, $post_id ) {
+    $post_type = get_post_type( $post_id );
+    if ( ! $post_type ) {
+        return;
+    }
+
+    foreach ( wp_post_revision_meta_keys( $post_type ) as $meta_key ) {
+        if ( metadata_exists( 'post', $post_id, $meta_key ) ) {
+            _wp_copy_post_meta( $post_id, $revision_id, $meta_key );
+        }
+    }
 }
 
@@ -451 +501 @@
     update_post_meta( $post_id, '_edit_last', get_current_user_id() );
 
+    // Restore any revisioned meta fields.
+    wp_restore_post_revision_meta( $post_id, $revision['ID'] );
+
     /**
      * Fires after a post revision has been restored.
@@ -462 +515 @@
 
     return $post_id;
+}
+
+/**
+ * Restore the revisioned meta values for a post.
+ *
+ * @param int $post_id     The ID of the post to restore the meta to.
+ * @param int $revision_id The ID of the revision to restore the meta from.
+ *
+ * @since 6.4.0
+ */
+function wp_restore_post_revision_meta( $post_id, $revision_id ) {
+    $post_type = get_post_type( $post_id );
+    if ( ! $post_type ) {
+        return;
+    }
+
+    // Restore revisioned meta fields.
+    foreach ( wp_post_revision_meta_keys( $post_type ) as $meta_key ) {
+
+        // Clear any existing meta.
+        delete_post_meta( $post_id, $meta_key );
+
+        _wp_copy_post_meta( $revision_id, $post_id, $meta_key );
+    }
+}
+
+/**
+ * Copy post meta for the given key from one post to another.
+ *
+ * @param int    $source_post_id Post ID to copy meta value(s) from.
+ * @param int    $target_post_id Post ID to copy meta value(s) to.
+ * @param string $meta_key       Meta key to copy.
+ *
+ * @since 6.4.0
+ */
+function _wp_copy_post_meta( $source_post_id, $target_post_id, $meta_key ) {
+
+    foreach ( get_post_meta( $source_post_id, $meta_key ) as $meta_value ) {
+        /**
+         * We use add_metadata() function vs add_post_meta() here
+         * to allow for a revision post target OR regular post.
+         */
+        add_metadata( 'post', $target_post_id, $meta_key, wp_slash( $meta_value ) );
+    }
+}
+
+/**
+ * Determine which post meta fields should be revisioned.
+ *
+ * @since 6.4.0
+ *
+ * @param string $post_type The post type being revisioned.
+ *
+ * @return array An array of meta keys to be revisioned.
+ */
+function wp_post_revision_meta_keys( $post_type ) {
+    $registered_meta = array_merge(
+        get_registered_meta_keys( 'post' ),
+        get_registered_meta_keys( 'post', $post_type )
+    );
+
+    $wp_revisioned_meta_keys = array();
+
+    foreach ( $registered_meta as $name => $args ) {
+        if ( $args['revisions_enabled'] ) {
+            $wp_revisioned_meta_keys[ $name ] = true;
+        }
+    }
+
+    $wp_revisioned_meta_keys = array_keys( $wp_revisioned_meta_keys );
+
+    /**
+     * Filter the list of post meta keys to be revisioned.
+     *
+     * @since 6.4.0
+     *
+     * @param array $keys       An array of meta fields to be revisioned.
+     * @param string $post_type The post type being revisioned.
+     */
+    return apply_filters( 'wp_post_revision_meta_keys', $wp_revisioned_meta_keys, $post_type );
+}
+
+/**
+ * Check whether revisioned post meta fields have changed.
+ *
+ * @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.
+ *
+ * @since 6.4.0
+ */
+function wp_check_revisioned_meta_fields_have_changed( $post_has_changed, WP_Post $last_revision, WP_Post $post ) {
+    foreach ( wp_post_revision_meta_keys( $post->post_type ) as $meta_key ) {
+        if ( get_post_meta( $post->ID, $meta_key ) !== get_post_meta( $last_revision->ID, $meta_key ) ) {
+            $post_has_changed = true;
+            break;
+        }
+    }
+    return $post_has_changed;
 }
 
@@ -729 +881 @@
     add_filter( 'get_the_terms', '_wp_preview_terms_filter', 10, 3 );
     add_filter( 'get_post_metadata', '_wp_preview_post_thumbnail_filter', 10, 3 );
+    add_filter( 'get_post_metadata', '_wp_preview_meta_filter', 10, 4 );
 
     return $post;
@@ -947 +1100 @@
     return true;
 }
+
+/**
+ * Filters preview post meta retrieval to get values from the autosave.
+ *
+ * Filters revisioned meta keys only.
+ *
+ * @since 6.4.0
+ *
+ * @param mixed  $value     Meta value to filter.
+ * @param int    $object_id Object ID.
+ * @param string $meta_key  Meta key to filter a value for.
+ * @param bool   $single    Whether to return a single value. Default false.
+ * @return mixed Original meta value if the meta key isn't revisioned, the object doesn't exist,
+ *               the post type is a revision or the post ID doesn't match the object ID.
+ *               Otherwise, the revisioned meta value is returned for the preview.
+ */
+function _wp_preview_meta_filter( $value, $object_id, $meta_key, $single ) {
+
+    $post = get_post();
+    if (
+        empty( $post ) ||
+        $post->ID !== $object_id ||
+        ! in_array( $meta_key, wp_post_revision_meta_keys( $post->post_type ), true ) ||
+        'revision' === $post->post_type
+    ) {
+        return $value;
+    }
+
+    $preview = wp_get_post_autosave( $post->ID );
+    if ( false === $preview ) {
+        return $value;
+    }
+
+    return get_post_meta( $preview->ID, $meta_key, $single );
+}