<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[55254] trunk: Revisions: Add a way to filter the revisions considered for deletion.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/55254">55254</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/55254","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>audrasjb</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-02-07 12:38:01 +0000 (Tue, 07 Feb 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Revisions: Add a way to filter the revisions considered for deletion.
This changeset introduces a new filter for `wp_save_post_revision()`. `wp_save_post_revision_revisions_before_deletion` passes the revisions to be considered for deletion, and the new revision's post ID.
This allows extenders to exclude specific revisions from being considered for deletion.
Props jhned, costdev, audrasjb, adamsilverstein, mukesh27.
Fixes <a href="https://core.trac.wordpress.org/ticket/57320">#57320</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrevisionphp">trunk/src/wp-includes/revision.php</a></li>
<li><a href="#trunktestsphpunittestspostrevisionsphp">trunk/tests/phpunit/tests/post/revisions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrevisionphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/revision.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/revision.php 2023-02-07 12:28:32 UTC (rev 55253)
+++ trunk/src/wp-includes/revision.php 2023-02-07 12:38:01 UTC (rev 55254)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -200,6 +200,35 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $revisions = wp_get_post_revisions( $post_id, array( 'order' => 'ASC' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the revisions to be considered for deletion.
+ *
+ * @since 6.2.0
+ *
+ * @param WP_Post[]|int[] $revisions Array of revision objects or IDs,
+ * or an empty array if none.
+ * @param int $post_id The ID of the post to save as a revision.
+ */
+ $filtered_revisions = apply_filters(
+ 'wp_save_post_revision_revisions_before_deletion',
+ $revisions,
+ $post_id
+ );
+
+ if ( is_array( $filtered_revisions ) ) {
+ $revisions = $filtered_revisions;
+ } else {
+ _doing_it_wrong(
+ __FUNCTION__,
+ sprintf(
+ /* translators: %s: The filter name. */
+ __( 'The "%s" filter should return an array.' ),
+ 'wp_save_post_revision_revisions_before_deletion'
+ ),
+ '6.2.0'
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $delete = count( $revisions ) - $revisions_to_keep;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $delete < 1 ) {
</span></span></pre></div>
<a id="trunktestsphpunittestspostrevisionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/post/revisions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/post/revisions.php 2023-02-07 12:28:32 UTC (rev 55253)
+++ trunk/tests/phpunit/tests/post/revisions.php 2023-02-07 12:38:01 UTC (rev 55254)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -866,4 +866,115 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> add_post_type_support( 'post', 'revisions' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Tests that wp_save_post_revision() respects the 'wp_save_post_revision_revisions_before_deletion' filter
+ * when deleting revisions.
+ *
+ * This test should protect the original revision, send the rest to be checked against wp_revisions_to_keep(),
+ * and result in two revisions: The latest revision, and the original.
+ *
+ * @ticket 57320
+ *
+ * @covers ::wp_save_post_revision
+ */
+ public function test_wp_save_post_revision_should_respect_revisions_before_deletion_filter() {
+ $post_id = self::factory()->post->create( array( 'post_title' => 'Test 57320' ) );
+
+ add_filter(
+ 'wp_revisions_to_keep',
+ static function() {
+ return 1;
+ }
+ );
+
+ add_filter(
+ 'wp_save_post_revision_revisions_before_deletion',
+ static function ( $revisions ) {
+ // Ignore the first revision and return the rest for deletion.
+ return array_slice( $revisions, 1 );
+ }
+ );
+
+ for ( $update = 1; $update < 4; ++$update ) {
+ wp_update_post(
+ array(
+ 'ID' => $post_id,
+ 'post_title' => 'Test 57320 Update ' . $update,
+ )
+ );
+ }
+
+ $actual = wp_get_post_revisions( $post_id );
+
+ $this->assertCount(
+ 2,
+ $actual,
+ 'There should be two revisions.'
+ );
+
+ $first = reset( $actual );
+ $second = next( $actual );
+
+ $this->assertSame(
+ 'Test 57320 Update 3',
+ $first->post_title,
+ 'The title of the first revision was incorrect.'
+ );
+
+ $this->assertSame(
+ 'Test 57320 Update 1',
+ $second->post_title,
+ 'The title of the second revision was incorrect.'
+ );
+ }
+
+ /**
+ * Tests that wp_save_post_revision() ignores an invalid return value
+ * from the 'wp_save_post_revision_revisions_before_deletion' filter
+ * and throws _doing_it_wrong().
+ *
+ * @ticket 57320
+ *
+ * @covers ::wp_save_post_revision
+ *
+ * @expectedIncorrectUsage wp_save_post_revision
+ */
+ public function test_wp_save_post_revision_should_ignore_invalid_revisions_before_deletion_filter() {
+ $post_id = self::factory()->post->create( array( 'post_title' => 'Test 57320' ) );
+
+ add_filter(
+ 'wp_revisions_to_keep',
+ static function() {
+ return 1;
+ }
+ );
+
+ add_filter( 'wp_save_post_revision_revisions_before_deletion', '__return_null' );
+
+ for ( $update = 1; $update < 4; ++$update ) {
+ wp_update_post(
+ array(
+ 'ID' => $post_id,
+ 'post_title' => 'Test 57320 Update ' . $update,
+ )
+ );
+ }
+
+ $actual = wp_get_post_revisions( $post_id );
+
+ $this->assertCount(
+ 1,
+ $actual,
+ 'There should only be one revision.'
+ );
+
+ $first = reset( $actual );
+
+ $this->assertSame(
+ 'Test 57320 Update 3',
+ $first->post_title,
+ 'The title of the first revision was incorrect.'
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>