Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revision with an array in meta saves correctly even when included in _wp_post_revision_fields. #5680

Open
wants to merge 4 commits into
base: trunk
Choose a base branch
from
Open

Revision with an array in meta saves correctly even when included in _wp_post_revision_fields. #5680

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ba94b81
Test that a revision with an array in meta saves correctly even when …
adamsilverstein Nov 17, 2023
d6dd548
phpcbf
adamsilverstein Nov 17, 2023
3b58627
only normalize screens when checking for revision field changes
adamsilverstein Nov 17, 2023
d3eabe8
Merge branch 'trunk' into ticket/59827
adamsilverstein Nov 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/wp-includes/revision.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,9 @@ function wp_save_post_revision( $post_id ) {
$post_has_changed = false;

foreach ( array_keys( _wp_post_revision_fields( $post ) ) as $field ) {
if ( normalize_whitespace( $post->$field ) !== normalize_whitespace( $latest_revision->$field ) ) {
$compare_from = is_string( $post->$field ) ? normalize_whitespace( $post->$field ) : $post->$field;
$compare_to = is_string( $latest_revision->$field ) ? normalize_whitespace( $latest_revision->$field ) : $latest_revision->$field;
if ( $compare_from !== $compare_to ) {
$post_has_changed = true;
break;
}
Expand Down
86 changes: 85 additions & 1 deletion tests/phpunit/tests/post/metaRevisions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -552,7 +552,7 @@ public function test_revisionining_of_meta_with_default_value() {
$revisions = wp_get_post_revisions( $post_id );
$last_revision = array_shift( $revisions );

// No ,eta data should be stored in the revision.
// No meta data should be stored in the revision.
$this->assertEquals( array(), get_post_meta( $last_revision->ID ) );

// Set the test meta again.
Expand Down Expand Up @@ -719,4 +719,88 @@ public function page_post_type_data_provider() {
),
);
}

/**
* Test that a revision with an array in meta saves correctly even when included in `_wp_post_revision_fields`.
*
* @ticket 59827
*/
public function test_wp_save_post_revision_with_array_meta() {

// Add a meta field to revision that includes a default value.
register_post_meta(
'post',
'meta_revision_test',
array(
'single' => true,
'type' => 'array',
'revisions_enabled' => true,
)
);

// Add the meta value to `_wp_post_revision_fields` which triggers it being compared for save consideration.
add_filter(
'_wp_post_revision_fields',
function ( $fields ) {
$fields['meta_revision_test'] = 'Meta Revisions Test';
return $fields;
}
);

// Set up a new post.
$post_id = $this->factory->post->create(
array(
'post_content' => 'initial content',
'meta_input' => array(
'meta_revision_test' => 'foo',
),
)
);

// Set the test meta to an array.
update_post_meta( $post_id, 'meta_revision_test', array( 'test' ) );

// Update to save.
wp_update_post( array( 'ID' => $post_id ) );

// Check that the meta is stored correctly.
$stored_data = get_post_meta( $post_id, 'meta_revision_test', true );
$this->assertEquals( array( 'test' ), $stored_data );

// Also verify that the latest revision has stored the meta.
$revisions = wp_get_post_revisions( $post_id );
$last_revision = array_shift( $revisions );
$stored_data = get_post_meta( $last_revision->ID, 'meta_revision_test', true );
$this->assertEquals( array( 'test' ), $stored_data );

// Update the meta.
update_post_meta( $post_id, 'meta_revision_test', array( 'changed' ) );

// Update to save.
wp_update_post(
array(
'ID' => $post_id,
'post_content' => 'content update 1',
)
);

// Check that the correct meta value is returned.
$this->assertEquals( array( 'changed' ), get_post_meta( $post_id, 'meta_revision_test', true ) );

// Also verify that the latest revision has the correct meta value.
$revisions = wp_get_post_revisions( $post_id );
$last_revision = array_shift( $revisions );

// Set the test meta again.
update_post_meta( $post_id, 'meta_revision_test', 'test' );

// Update to save.
wp_update_post( array( 'ID' => $post_id ) );

// Now restore the previous revision.
wp_restore_post_revision( $last_revision->ID );

// Verify the correct meta value is still returned.
$this->assertEquals( array( 'changed' ), get_post_meta( $post_id, 'meta_revision_test', true ) );
}
}
Loading