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

Timestamp:

02/07/2023 12:38:01 PM (2 years ago)

Author:

audrasjb

Message:

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 #57320.

File:

• trunk/src/wp-includes/revision.php (modified) (1 diff)

trunk/src/wp-includes/revision.php

@@ -201 +201 @@
     $revisions = wp_get_post_revisions( $post_id, array( 'order' => 'ASC' ) );
 
+    /**
+     * 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'
+        );
+    }
+
     $delete = count( $revisions ) - $revisions_to_keep;