Changeset 56714

Timestamp:

09/26/2023 03:30:34 PM (10 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.

Location:

trunk

Files:

• src/wp-admin/includes/post.php (modified) (2 diffs)
• src/wp-includes/default-filters.php (modified) (2 diffs)
• src/wp-includes/meta.php (modified) (4 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-autosaves-controller.php (modified) (4 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php (modified) (4 diffs)
• src/wp-includes/revision.php (modified) (7 diffs)
• tests/phpunit/tests/meta/registerMeta.php (modified) (6 diffs)
• tests/phpunit/tests/post/metaRevisions.php (added)
• tests/phpunit/tests/rest-api/rest-autosaves-controller.php (modified) (3 diffs)
• tests/phpunit/tests/rest-api/rest-global-styles-revisions-controller.php (modified) (4 diffs)
• tests/phpunit/tests/rest-api/rest-post-meta-fields.php (modified) (5 diffs)
• tests/phpunit/tests/rest-api/rest-revisions-controller.php (modified) (3 diffs)
• tests/phpunit/tests/user/wpRegisterPersistedPreferencesMeta.php (modified) (1 diff)
• tests/qunit/fixtures/wp-api-generated.js (modified) (10 diffs)

trunk/src/wp-admin/includes/post.php

@@ -1971 +1971 @@
          *
          * @since 4.1.0
+
          *
          * @param array $new_autosave Post array - the autosave that is about to be saved.
+
          */
-        do_action( 'wp_creating_autosave', $new_autosave );
-
+        do_action( 'wp_creating_autosave', $new_autosave, true );
         return wp_update_post( $new_autosave );
     }
@@ -1983 +1984 @@
 
     // Otherwise create the new autosave as a special post revision.
-    return _wp_put_post_revision( $post_data, true );
+    $revision = _wp_put_post_revision( $post_data, true );
+
+    if ( ! is_wp_error( $revision ) && 0 !== $revision ) {
+
+        /** This action is documented in wp-admin/includes/post.php */
+        do_action( 'wp_creating_autosave', get_post( $revision, ARRAY_A ), false );
+    }
+
+    return $revision;
+}
+
+/**
+ * Autosave the revisioned meta fields.
+ *
+ * Iterates through the revisioned meta fields and checks each to see if they are set,
+ * and have a changed value. If so, the meta value is saved and attached to the autosave.
+ *
+ * @since 6.4.0
+ *
+ * @param array $new_autosave The new post data being autosaved.
+ */
+function wp_autosave_post_revisioned_meta_fields( $new_autosave ) {
+    /*
+     * The post data arrives as either $_POST['data']['wp_autosave'] or the $_POST
+     * itself. This sets $posted_data to the correct variable.
+     *
+     * Ignoring sanitization to avoid altering meta. Ignoring the nonce check because
+     * this is hooked on inner core hooks where a valid nonce was already checked.
+     *
+     * @phpcs:disable WordPress.Security
+     */
+    $posted_data = isset( $_POST['data']['wp_autosave'] ) ? $_POST['data']['wp_autosave'] : $_POST;
+    // phpcs:enable
+
+    $post_type = get_post_type( $new_autosave['post_parent'] );
+
+    /*
+     * Go thru the revisioned meta keys and save them as part of the autosave, if
+     * the meta key is part of the posted data, the meta value is not blank and
+     * the the meta value has changes from the last autosaved value.
+     */
+    foreach ( wp_post_revision_meta_keys( $post_type ) as $meta_key ) {
+
+        if (
+        isset( $posted_data[ $meta_key ] ) &&
+        get_post_meta( $new_autosave['ID'], $meta_key, true ) !== wp_unslash( $posted_data[ $meta_key ] )
+        ) {
+            /*
+             * Use the underlying delete_metadata() and add_metadata() functions
+             * vs delete_post_meta() and add_post_meta() to make sure we're working
+             * with the actual revision meta.
+             */
+            delete_metadata( 'post', $new_autosave['ID'], $meta_key );
+
+            /*
+             * One last check to ensure meta value not empty().
+             */
+            if ( ! empty( $posted_data[ $meta_key ] ) ) {
+                /*
+                 * Add the revisions meta data to the autosave.
+                 */
+                add_metadata( 'post', $new_autosave['ID'], $meta_key, $posted_data[ $meta_key ] );
+            }
+        }
+    }
 }
 

trunk/src/wp-includes/default-filters.php

@@ -412 +412 @@
 add_action( 'shutdown', 'wp_ob_end_flush_all', 1 );
 // Create a revision whenever a post is updated.
+
 add_action( 'post_updated', 'wp_save_post_revision', 10, 1 );
 add_action( 'publish_post', '_publish_post_hook', 5, 1 );
@@ -720 +721 @@
 add_action( 'init', 'wp_create_initial_post_meta' );
 
+
+
+
+
+
+
+
+
+
+
+
+
 // Font management.
 add_action( 'wp_head', 'wp_print_font_faces', 50 );

trunk/src/wp-includes/meta.php

@@ -1368 +1368 @@
  * @since 5.3.0 Valid meta types expanded to include "array" and "object".
  * @since 5.5.0 The `$default` argument was added to the arguments array.
+
  *
  * @param string       $object_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user',
@@ -1393 +1394 @@
  *                                         When registering complex meta values this argument may optionally be an
  *                                         array with 'schema' or 'prepare_callback' keys instead of a boolean.
+
+
  * }
  * @param string|array $deprecated Deprecated. Use `$args` instead.
@@ -1415 +1418 @@
         'auth_callback'     => null,
         'show_in_rest'      => false,
+
     );
 
@@ -1461 +1465 @@
 
     $object_subtype = ! empty( $args['object_subtype'] ) ? $args['object_subtype'] : '';
+
+
+
+
+
+
+
+
+
+
+
 
     // If `auth_callback` is not provided, fall back to `is_protected_meta()`.

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-autosaves-controller.php

@@ -235 +235 @@
             $autosave_id = wp_update_post( wp_slash( (array) $prepared_post ), true );
         } else {
-            // Non-draft posts: create or update the post autosave.
-            $autosave_id = $this->create_post_autosave( (array) $prepared_post );
+            // Non-draft posts: create or update the post autosave.
+            $autosave_id = $this->create_post_autosave( (array) $prepared_post );
         }
 
@@ -349 +349 @@
      *
      * @since 5.0.0
+
      *
      * @param array $post_data Associative array containing the post data.
+
      * @return mixed The autosave revision ID or WP_Error.
      */
-    public function create_post_autosave( $post_data ) {
+    public function create_post_autosave( $post_data ) {
 
         $post_id = (int) $post_data['ID'];
@@ -373 +375 @@
         }
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
         $user_id = get_current_user_id();
 
@@ -391 +408 @@
 
             // wp_update_post() expects escaped array.
-            return wp_update_post( wp_slash( $new_autosave ) );
-        }
-
-        // Create the new autosave as a special post revision.
-        return _wp_put_post_revision( $post_data, true );
+            $revision_id = wp_update_post( wp_slash( $new_autosave ) );
+        } else {
+            // Create the new autosave as a special post revision.
+            $revision_id = _wp_put_post_revision( $post_data, true );
+        }
+
+        if ( is_wp_error( $revision_id ) || 0 === $revision_id ) {
+            return $revision_id;
+        }
+
+        // Attached any passed meta values that have revisions enabled.
+        if ( ! empty( $meta ) ) {
+            foreach ( $revisioned_meta_keys as $meta_key ) {
+                if ( isset( $meta[ $meta_key ] ) ) {
+                    update_metadata( 'post', $revision_id, $meta_key, $meta[ $meta_key ] );
+                }
+            }
+        }
+
+        return $revision_id;
     }
 

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

@@ -26 +26 @@
 
     /**
+
+
+
+
+
+
+
+
      * Parent controller.
      *
@@ -61 +69 @@
         $this->parent_base       = ! empty( $post_type_object->rest_base ) ? $post_type_object->rest_base : $post_type_object->name;
         $this->namespace         = ! empty( $post_type_object->rest_namespace ) ? $post_type_object->rest_namespace : 'wp/v2';
+
     }
 
@@ -620 +629 @@
         }
 
+
+
+
+
         $context  = ! empty( $request['context'] ) ? $request['context'] : 'view';
         $data     = $this->add_additional_fields_to_object( $data, $request );
@@ -752 +765 @@
             $schema['properties']['guid'] = $parent_schema['properties']['guid'];
         }
+
+
 
         $this->schema = $schema;

trunk/src/wp-includes/revision.php

@@ -97 +97 @@
 
 /**
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
  * 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;
     }
@@ -362 +388 @@
          *
          * @since 2.6.0
+
          *
          * @param int $revision_id Post revision ID.
+
          */
-        do_action( '_wp_put_post_revision', $revision_id );
+        do_action( '_wp_put_post_revision', $revision_id );
     }
 
     return $revision_id;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 }
 
@@ -451 +501 @@
     update_post_meta( $post_id, '_edit_last', get_current_user_id() );
 
+
+
+
     /**
      * Fires after a post revision has been restored.
@@ -462 +515 @@
 
     return $post_id;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 }
 
@@ -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 );
+
 
     return $post;
@@ -947 +1100 @@
     return true;
 }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

trunk/tests/phpunit/tests/meta/registerMeta.php

@@ -98 +98 @@
                         'auth_callback'     => '__return_true',
                         'show_in_rest'      => false,
+
                     ),
                 ),
@@ -122 +123 @@
                         'auth_callback'     => '__return_true',
                         'show_in_rest'      => false,
+
                     ),
                 ),
@@ -176 +178 @@
                         'auth_callback'     => '__return_true',
                         'show_in_rest'      => false,
+
                     ),
                 ),
@@ -343 +346 @@
                         'auth_callback'     => '__return_true',
                         'show_in_rest'      => false,
+
                     ),
                 ),
@@ -396 +400 @@
                         'auth_callback'     => '__return_true',
                         'show_in_rest'      => false,
+
                     ),
                 ),
@@ -1082 +1087 @@
         );
     }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 }

trunk/tests/phpunit/tests/rest-api/rest-autosaves-controller.php

@@ -216 +216 @@
             'date',
             'date_gmt',
+
+
             'modified',
             'modified_gmt',
-            'guid',
-            'id',
             'parent',
             'slug',
+
             'title',
             'excerpt',
@@ -289 +290 @@
         $data       = $response->get_data();
         $properties = $data['schema']['properties'];
-        $this->assertCount( 13, $properties );
+        $this->assertCount( 1, $properties );
         $this->assertArrayHasKey( 'author', $properties );
         $this->assertArrayHasKey( 'content', $properties );
@@ -303 +304 @@
         $this->assertArrayHasKey( 'title', $properties );
         $this->assertArrayHasKey( 'preview_link', $properties );
+
     }
 

trunk/tests/phpunit/tests/rest-api/rest-global-styles-revisions-controller.php

@@ -133 +133 @@
         );
 
-        wp_update_post( $new_styles_post, true, false );
+        wp_update_post( $new_styles_post, true );
 
         $new_styles_post = array(
@@ -163 +163 @@
         );
 
-        wp_update_post( $new_styles_post, true, false );
+        wp_update_post( $new_styles_post, true );
 
         $new_styles_post = array(
@@ -193 +193 @@
         );
 
-        wp_update_post( $new_styles_post, true, false );
+        wp_update_post( $new_styles_post, true );
         wp_set_current_user( 0 );
     }
@@ -327 +327 @@
         );
 
-        wp_update_post( $updated_styles_post, true, false );
+        wp_update_post( $updated_styles_post, true );
 
         $request  = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );

trunk/tests/phpunit/tests/rest-api/rest-post-meta-fields.php

@@ -18 +18 @@
             array(
                 'show_in_rest' => true,
-                'supports'     => array( 'custom-fields' ),
+                'supports'     => array( 'custom-fields' ),
             )
         );
@@ -158 +158 @@
             array(
                 'show_in_rest' => true,
-                'supports'     => array( 'custom-fields' ),
+                'supports'     => array( 'custom-fields' ),
             )
         );
@@ -1377 +1377 @@
      */
     public function test_update_value_return_success_with_same_value( $meta_key, $meta_value ) {
-        add_post_meta( self::$post_id, $meta_key, $meta_value );
-
         $this->grant_write_permission();
 
@@ -1393 +1391 @@
 
         $this->assertSame( 200, $response->get_status() );
+
+
+
+
+
+
     }
 
@@ -3113 +3117 @@
         return $query;
     }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 }

trunk/tests/phpunit/tests/rest-api/rest-revisions-controller.php

@@ -180 +180 @@
             'guid',
             'id',
+
             'parent',
             'slug',
@@ -336 +337 @@
         $data       = $response->get_data();
         $properties = $data['schema']['properties'];
-        $this->assertCount( 12, $properties );
+        $this->assertCount( 1, $properties );
         $this->assertArrayHasKey( 'author', $properties );
         $this->assertArrayHasKey( 'content', $properties );
@@ -349 +350 @@
         $this->assertArrayHasKey( 'slug', $properties );
         $this->assertArrayHasKey( 'title', $properties );
+
     }
 

trunk/tests/phpunit/tests/user/wpRegisterPersistedPreferencesMeta.php

@@ -53 +53 @@
                     ),
                 ),
+
             ),
             $wp_meta_keys['user'][''][ $meta_key ],

trunk/tests/qunit/fixtures/wp-api-generated.js

@@ -11783 +11783 @@
             "rendered": ""
         },
+
+
+
         "_links": {
             "parent": [
@@ -11811 +11814 @@
         "excerpt": {
             "rendered": "<p>REST API Client Fixture: Post</p>\n"
+
+
+
         },
         "_links": {
@@ -11842 +11848 @@
     "excerpt": {
         "rendered": "<p>REST API Client Fixture: Post</p>\n"
+
+
+
     }
 };
@@ -11866 +11875 @@
         "excerpt": {
             "rendered": ""
+
+
+
         },
         "_links": {
@@ -11897 +11909 @@
     "excerpt": {
         "rendered": ""
+
+
+
     }
 };
@@ -12043 +12058 @@
             "rendered": ""
         },
+
+
+
         "_links": {
             "parent": [
@@ -12071 +12089 @@
         "excerpt": {
             "rendered": "<p>REST API Client Fixture: Page</p>\n"
+
+
+
         },
         "_links": {
@@ -12102 +12123 @@
     "excerpt": {
         "rendered": "<p>REST API Client Fixture: Page</p>\n"
+
+
+
     }
 };
@@ -12126 +12150 @@
         "excerpt": {
             "rendered": ""
+
+
+
         },
         "_links": {
@@ -12157 +12184 @@
     "excerpt": {
         "rendered": ""
+
+
+
     }
 };