WordPress.org

Make WordPress Core

Ticket #20564: 20564.8.diff

File 20564.8.diff, 9.9 KB (added by DrewAPicture, 8 years ago)

+ docs fixes

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

     
    13501350                $new_autosave['ID'] = $old_autosave->ID;
    13511351                $new_autosave['post_author'] = $post_author;
    13521352
     1353                // Auto-save revisioned meta fields.
     1354                foreach ( _wp_post_revision_meta_keys() as $meta_key ) {
     1355                        if ( isset( $_POST[ $meta_key ] )
     1356                                && get_post_meta( $new_autosave['ID'], $meta_key, true ) != $_POST[ $meta_key ] )
     1357                        {
     1358                                /*
     1359                                 * Use the underlying delete_metadata() and add_metadata() functions
     1360                                 * vs delete_post_meta() and add_post_meta() to make sure we're working
     1361                                 * with the actual revision meta.
     1362                                 */
     1363                                delete_metadata( 'post', $new_autosave['ID'], $meta_key );
     1364                                if ( ! empty( $_POST[ $meta_key ] ) ) {
     1365                                        add_metadata( 'post', $new_autosave['ID'], $meta_key, $_POST[ $meta_key ] );
     1366                                }
     1367                        }
     1368                }
     1369
    13531370                // If the new autosave is the same content as the post, delete the old autosave.
    13541371                $post = get_post( $post_id );
    13551372                $autosave_is_different = false;
  • src/wp-includes/revision.php

     
    2828        if ( !$fields ) {
    2929                // Allow these to be versioned
    3030                $fields = array(
    31                         'post_title' => __( 'Title' ),
     31                        'post_title'   => __( 'Title' ),
    3232                        'post_content' => __( 'Content' ),
    3333                        'post_excerpt' => __( 'Excerpt' ),
    3434                );
    3535
    36                 // Runs only once
     36                /**
     37                 * Filter the list of post fields to be revisioned.
     38                 *
     39                 * Fields are only revisioned once.
     40                 *
     41                 * @since 3.9.0
     42                 *
     43                 * @param array $fields An array of fields to be revisioned.
     44                 */
    3745                $fields = apply_filters( '_wp_post_revision_fields', $fields );
    3846
    3947                // WP uses these internally either in versioning or elsewhere - they cannot be versioned
    40                 foreach ( array( 'ID', 'post_name', 'post_parent', 'post_date', 'post_date_gmt', 'post_status', 'post_type', 'comment_count', 'post_author' ) as $protect )
     48                foreach ( array( 'ID', 'post_name', 'post_parent', 'post_date', 'post_date_gmt', 'post_status', 'post_type', 'comment_count', 'post_author' ) as $protect ) {
    4149                        unset( $fields[$protect] );
     50                }
    4251        }
    4352
    4453        if ( !is_array($post) )
     
    5968}
    6069
    6170/**
     71 * Determine which post meta fields should be revisioned.
     72 *
     73 * @access private
     74 * @since 3.9.0
     75 *
     76 * @return array An array of meta keys to be revisioned.
     77 */
     78function _wp_post_revision_meta_keys() {
     79        /**
     80         * Filter the list of post meta keys to be revisioned.
     81         *
     82         * @since 3.9.0
     83         *
     84         * @param array $keys An array of default meta fields to be revisioned.
     85         */
     86        return apply_filters( 'wp_post_revision_meta_keys', array() );
     87}
     88
     89/**
    6290 * Saves an already existing post as a post revision.
    6391 *
    6492 * Typically used immediately after post updates.
     
    102130                if ( isset( $last_revision ) && apply_filters( 'wp_save_post_revision_check_for_changes', true, $last_revision, $post ) ) {
    103131                        $post_has_changed = false;
    104132
     133                        // Check whether revisioned post fields have been changed.
    105134                        foreach ( array_keys( _wp_post_revision_fields() ) as $field ) {
    106135                                if ( normalize_whitespace( $post->$field ) != normalize_whitespace( $last_revision->$field ) ) {
    107136                                        $post_has_changed = true;
    108137                                        break;
    109138                                }
    110139                        }
    111                         //don't save revision if post unchanged
     140
     141                        // Check whether revisioned post meta fields have changed.
     142                        foreach ( _wp_post_revision_meta_keys() as $meta_key ) {
     143                                if ( get_post_meta( $post->ID, $meta_key ) != get_post_meta( $last_revision->ID, $meta_key ) ) {
     144                                        $post_has_changed = true;
     145                                        break;
     146                                }
     147                        }
     148
     149                        // Don't save revision if the post is unchanged.
    112150                        if( ! $post_has_changed )
    113151                                return;
    114152                }
     
    240278        if ( $revision_id )
    241279                do_action( '_wp_put_post_revision', $revision_id );
    242280
     281        // Save revisioned meta fields.
     282        foreach ( _wp_post_revision_meta_keys() as $meta_key ) {
     283                $meta_value = get_post_meta( $post_id, $meta_key, true );
     284                if ( empty( $meta_value ) ) {
     285                        continue;
     286                }
     287
     288                /*
     289                 * Use the underlying add_metadata() function vs add_post_meta()
     290                 * to ensure metadata is added to the revision post and not its parent.
     291                 */
     292                add_metadata( 'post', $revision_id, $meta_key, wp_slash( $meta_value ) );
     293        }
     294
    243295        return $revision_id;
    244296}
    245297
     
    308360
    309361        $update['ID'] = $revision['post_parent'];
    310362
     363        // Restore revisioned meta fields.
     364        foreach ( _wp_post_revision_meta_keys() as $meta_key ) {
     365                $meta_value = get_post_meta( $revision['ID'], $meta_key, true );
     366                if ( empty( $meta_value ) ) {
     367                        $meta_value = '';
     368                }
     369
     370                // Add slashes to data pulled from the database.
     371                update_post_meta( $update['ID'], $meta_key, wp_slash( $meta_value ) );
     372        }
     373
    311374        $update = wp_slash( $update ); //since data is from db
    312375
     376        // Restore revisioned meta fields.
     377        foreach ( _wp_post_revision_meta_keys() as $meta_key ) {
     378                delete_post_meta( $update['ID'], $meta_key );
     379                $meta_values = get_post_meta( $revision['ID'], $meta_key );
     380                if ( false === $meta_values ) {
     381                        continue;
     382                }
     383
     384                foreach ( $meta_values as $meta_value ) {
     385                        add_post_meta( $update['ID'], $meta_key, $meta_value );
     386                }
     387        }
     388
    313389        $post_id = wp_update_post( $update );
    314390        if ( ! $post_id || is_wp_error( $post_id ) )
    315391                return $post_id;
     
    449525        $post->post_excerpt = $preview->post_excerpt;
    450526
    451527        add_filter( 'get_the_terms', '_wp_preview_terms_filter', 10, 3 );
     528        add_filter( 'get_post_metadata', '_wp_preview_meta_filter', 10, 4 );
    452529
    453530        return $post;
    454531}
     
    472549}
    473550
    474551/**
     552 * Filters post meta retrieval to get values from the actual autosave post,
     553 * and not its parent.
     554 *
     555 * Filters revisioned meta keys only.
     556 *
     557 * @access private
     558 * @since 3.9.0
     559 *
     560 * @param mixed  $value     Meta value to filter.
     561 * @param int    $object_id Object ID.
     562 * @param string $meta_key  Meta key to filter a value for.
     563 * @param bool   $single    Whether to return a single value. Default false.
     564 * @return mixed Original meta value if the meta key isn't revisioned, the object doesn't exist,
     565 *               the post type is a revisionm or the post ID doesn't match the object ID.
     566 *               Otherwise, the revisioned meta value is returned for the preview.
     567 */
     568function _wp_preview_meta_filter( $value, $object_id, $meta_key, $single ) {
     569        $post = get_post();
     570        if ( empty( $post )
     571                || $post->ID != $object_id
     572                || ! in_array( $meta_key, _wp_post_revision_meta_keys() )
     573                || 'revision' == $post->post_type )
     574        {
     575                return $value;
     576        }
     577
     578        // Grab the autosave.
     579        $preview = wp_get_post_autosave( $post->ID );
     580        if ( ! is_object( $preview ) ) {
     581                return $value;
     582        }
     583
     584        return get_post_meta( $preview->ID, $meta_key, $single );
     585}
     586
     587/**
    475588 * Filters terms lookup to set the post format.
    476589 *
    477590 * @since 3.6.0
  • tests/phpunit/tests/post/revisions.php

     
    338338                        $this->assertTrue( user_can( $author_user_id, 'read_post', $revision->ID ) );
    339339                }
    340340        }
     341
     342        /**
     343         * Test the revisions system for storage of meta values
     344         * @ticket 20564
     345         */
     346        function test_revisions_stores_meta_values() {
     347                // Set up a new post
     348                $original_post_id = $post_id = $this->factory->post->create();
     349                // And update to store an initial revision
     350                wp_update_post( array( 'post_content'   => 'some initial content', 'ID' => $post_id ) );
     351
     352                /**
     353                 * First set up a meta value
     354                 */
     355
     356                // Store a custom meta value, which is not revisioned by default
     357                update_post_meta( $post_id, 'meta_revision_test', 'original' );
     358
     359                // Update the post, storing a revision
     360                wp_update_post( array( 'post_content'   => 'some more content', 'ID' => $post_id ) );
     361
     362                //  Next, store some updated meta values for the same key
     363                update_post_meta( $post_id, 'meta_revision_test', 'update1' );
     364
     365                // Save the post, changing content to force a revision
     366                wp_update_post( array( 'post_content'   => 'some updated content', 'ID' => $post_id ) );
     367
     368                /**
     369                 * Now restore the original revision
     370                 */
     371
     372                // Get all the revisions
     373                $revisions = (Array)wp_get_post_revisions( $post_id );
     374
     375                // Go back two revisions (the 1st 'previous' revision matches the current post)
     376                array_pop( $revisions );
     377                $last_revision = array_pop( $revisions );
     378
     379                // Restore!
     380                wp_restore_post_revision( $last_revision->ID );
     381
     382                /**
     383                 * Check the meta values to verify they are NOT revisioned - they are not revisioned by default
     384                 */
     385
     386                // Custom post meta should NOT be restored, orignal value should not be restored, value still 'update1'
     387                $this->assertEquals( 'update1', get_post_meta( $post_id, 'meta_revision_test', true ) );
     388
     389                /*
     390                 * Now test the revisioning of custom meta when enabled by the wp_post_revision_meta_keys filter
     391                 */
     392
     393                // Add the custom field to be revised via the wp_post_revision_meta_keys filter
     394                add_filter( 'wp_post_revision_meta_keys', function( $keys ) {
     395                        $keys[] = 'meta_revision_test';
     396                        return $keys;
     397                });
     398
     399                /**
     400                 * Save new meta in the revisioned field
     401                 */
     402
     403                // Save the post again, custom meta should now be revisioned - note no change in content, revision still saved
     404                wp_update_post( array( 'ID' => $post_id ) );
     405
     406                // Store custom meta values, which should now be revisioned
     407                update_post_meta( $post_id, 'meta_revision_test', 'update2' );
     408
     409                // Save the post again
     410                wp_update_post( array( 'ID' => $post_id ) );
     411
     412                // Retore the previous revision
     413                $revisions = wp_get_post_revisions( $post_id );
     414
     415                // Go back two to load the previous revision
     416                array_pop( $revisions );
     417                $last_revision = array_pop( $revisions );
     418                wp_restore_post_revision( $last_revision->ID );
     419
     420                // Verify that previous post meta is restored
     421                $this->assertEquals( 'update1', get_post_meta( $post_id, 'meta_revision_test', true ) );
     422
     423                // Cleanup!
     424                wp_delete_post( $original_post_id );
     425
     426        }
    341427}