Changeset 49125 for trunk/src/wp-includes/post.php

Timestamp:

10/11/2020 01:37:04 PM (4 years ago)

Author:

johnbillion

Message:

Posts, Post Types: Switch to restoring posts to draft status by default when they are untrashed.

This allows for edits to be made to a restored post before it goes live again. This also prevents scheduled posts being published unexpectedly if they are untrashed after their originally scheduled date.

The old behaviour of restoring untrashed posts to their original status can be reinstated using the wp_untrash_post_set_previous_status() helper function.

Also fixes an issue where the incorrect post ID gets passed to hooks if no post ID is passed to the function.

Props harrym, bananastalktome, jaredcobb, chriscct7, melchoyce, johnbillion, pankajmohale

Fixes #23022

File:

• trunk/src/wp-includes/post.php (modified) (5 diffs)

trunk/src/wp-includes/post.php

@@ -3234 +3234 @@
 
 /**
- * Restore a post or page from the Trash.
+ * Restores a post from the Trash.
  *
  * @since 2.9.0
- *
- * @param int $post_id Optional. Post ID. Default is ID of the global $post.
+ * @since 5.6.0 An untrashed post is now returned to 'draft' status by default, except for
+ *              attachments which are returned to their original 'inherit' status.
+ *
+ * @param int $post_id Optional. Post ID. Default is ID of the global `$post`.
  * @return WP_Post|false|null Post data on success, false or null on failure.
  */
@@ -3248 +3250 @@
     }
 
+    $post_id = $post->ID;
+
     if ( 'trash' !== $post->post_status ) {
         return false;
     }
 
+    $previous_status = get_post_meta( $post_id, '_wp_trash_meta_status', true );
+
     /**
      * Filters whether a post untrashing should take place.
      *
      * @since 4.9.0
-     *
-     * @param bool|null $untrash Whether to go forward with untrashing.
-     * @param WP_Post   $post    Post object.
+     * @since 5.6.0 The `$previous_status` parameter was added.
+     *
+     * @param bool|null $untrash         Whether to go forward with untrashing.
+     * @param WP_Post   $post            Post object.
+     * @param string    $previous_status The status of the post at the point where it was trashed.
      */
-    $check = apply_filters( 'pre_untrash_post', null, $post );
+    $check = apply_filters( 'pre_untrash_post', null, $post, $previous_status );
     if ( null !== $check ) {
         return $check;
@@ -3269 +3277 @@
      *
      * @since 2.9.0
-     *
-     * @param int $post_id Post ID.
+     * @since 5.6.0 The `$previous_status` parameter was added.
+     *
+     * @param int    $post_id         Post ID.
+     * @param string $previous_status The status of the post at the point where it was trashed.
      */
-    do_action( 'untrash_post', $post_id );
-
-    $post_status = get_post_meta( $post_id, '_wp_trash_meta_status', true );
+    do_action( 'untrash_post', $post_id, $previous_status );
+
+    $new_status = ( 'attachment' === $post->post_type ) ? 'inherit' : 'draft';
+
+    /**
+     * Filters the status that a post gets assigned when it is restored from the trash (untrashed).
+     *
+     * By default posts that are restored will be assigned a status of 'draft'. Return the value of `$previous_status`
+     * in order to assign the status that the post had before it was trashed. The `wp_untrash_post_set_previous_status()`
+     * function is available for this.
+     *
+     * Prior to WordPress 5.6.0, restored posts were always assigned their original status.
+     *
+     * @since 5.6.0
+     *
+     * @param string $new_status      The new status of the post being restored.
+     * @param int    $post_id         The ID of the post being restored.
+     * @param string $previous_status The status of the post at the point where it was trashed.
+     */
+    $post_status = apply_filters( 'wp_untrash_post_status', $new_status, $post_id, $previous_status );
 
     delete_post_meta( $post_id, '_wp_trash_meta_status' );
@@ -3296 +3323 @@
      *
      * @since 2.9.0
-     *
-     * @param int $post_id Post ID.
+     * @since 5.6.0 The `$previous_status` parameter was added.
+     *
+     * @param int    $post_id         Post ID.
+     * @param string $previous_status The status of the post at the point where it was trashed.
      */
-    do_action( 'untrashed_post', $post_id );
+    do_action( 'untrashed_post', $post_id, $previous_status );
 
     return $post;
@@ -7514 +7543 @@
     return apply_filters( 'wp_get_original_image_url', $original_image_url, $attachment_id );
 }
+
+/**
+ * Filter callback which sets the status of an untrashed post to its previous status.
+ *
+ * This can be used as a callback on the `wp_untrash_post_status` filter.
+ *
+ * @since 5.6.0
+ *
+ * @param string $new_status      The new status of the post being restored.
+ * @param int    $post_id         The ID of the post being restored.
+ * @param string $previous_status The status of the post at the point where it was trashed.
+ * @return string The new status of the post.
+ */
+function wp_untrash_post_set_previous_status( $new_status, $post_id, $previous_status ) {
+    return $previous_status;
+}