Changeset 49732

Timestamp:

12/01/2020 08:55:03 PM (4 years ago)

Author:

johnbillion

Message:

REST API: Pass the previous state of the post as a parameter to the wp_after_insert_post hook.

This enables, for example, the previous post status to be used by this hook without the need to first capture it on an earlier hook.

This also fixes the value of the $fire_after_hooks parameter in get_default_post_to_edit() so the wp_after_insert_post action correctly fires just once on the new post screen.

This merges [45114] into the 5.6 branch

See #45114

Location:

branches/5.6

Files:

• . (modified) (1 prop)
• src/wp-admin/includes/post.php (modified) (2 diffs)
• src/wp-includes/class-wp-customize-manager.php (modified) (1 diff)
• src/wp-includes/post.php (modified) (6 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php (modified) (3 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (3 diffs)
• tests/phpunit/tests/post/wpAfterInsertPost.php (copied) (copied from trunk/tests/phpunit/tests/post/wpAfterInsertPost.php)

branches/5.6/src/wp-admin/includes/post.php

@@ -688 +688 @@
             ),
             false,
-            true
+            false
         );
         $post    = get_post( $post_id );
@@ -694 +694 @@
             set_post_format( $post, get_option( 'default_post_format' ) );
         }
-        wp_after_insert_post( $post, false );
+        wp_after_insert_post( $post, false, null );
 
         // Schedule auto-draft cleanup.

branches/5.6/src/wp-includes/class-wp-customize-manager.php

@@ -3106 +3106 @@
         do_action( 'wp_insert_post', $post->ID, $post, true );
 
-        wp_after_insert_post( $post, true );
+        wp_after_insert_post( get_post( $post_id ), true, $post );
 
         wp_trash_post_comments( $post_id );

branches/5.6/src/wp-includes/post.php

@@ -3718 +3718 @@
     } else {
         $previous_status = 'new';
+        $post_before     = null;
     }
 
@@ -4320 +4321 @@
 
     if ( $fire_after_hooks ) {
-        wp_after_insert_post( $post, $update );
+        wp_after_insert_post( $post, $update, $post_before );
     }
 
@@ -4433 +4434 @@
     }
 
+    $post_before = get_post( $post->ID );
+
     // Ensure at least one term is applied for taxonomies with a default term.
     foreach ( get_object_taxonomies( $post->post_type, 'object' ) as $taxonomy => $tax_object ) {
@@ -4483 +4486 @@
     do_action( 'wp_insert_post', $post->ID, $post, true );
 
-    wp_after_insert_post( $post, true );
+    wp_after_insert_post( $post, true, $post_before );
 }
 
@@ -4938 +4941 @@
  * @since 5.6.0
  *
- * @param int|WP_Post $post   The post ID or object that has been saved.
- * @param bool        $update Whether this is an existing post being updated.
- */
-function wp_after_insert_post( $post, $update ) {
+ * @param int|WP_Post  $post        The post ID or object that has been saved.
+ * @param bool         $update      Whether this is an existing post being updated.
+ * @param null|WP_Post $post_before Null for new posts, the WP_Post object prior
+ *                                  to the update for updated posts.
+ */
+function wp_after_insert_post( $post, $update, $post_before ) {
     $post = get_post( $post );
     if ( ! $post ) {
@@ -4954 +4959 @@
      * @since 5.6.0
      *
-     * @param int     $post_id Post ID.
-     * @param WP_Post $post    Post object.
-     * @param bool    $update  Whether this is an existing post being updated.
+     * @param int          $post_id     Post ID.
+     * @param WP_Post      $post        Post object.
+     * @param bool         $update      Whether this is an existing post being updated.
+     * @param null|WP_Post $post_before Null for new posts, the WP_Post object prior
+     *                                  to the update for updated posts.
      */
-    do_action( 'wp_after_insert_post', $post_id, $post, $update );
+    do_action( 'wp_after_insert_post', $post_id, $post, $update, $post_before );
 }
 

branches/5.6/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php

@@ -192 +192 @@
         do_action( 'rest_after_insert_attachment', $attachment, $request, true );
 
-        wp_after_insert_post( $attachment, false );
+        wp_after_insert_post( $attachment, false, null );
 
         if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
@@ -322 +322 @@
         }
 
-        $response = parent::update_item( $request );
+        $attachment_before = get_post( $request['id'] );
+        $response          = parent::update_item( $request );
 
         if ( is_wp_error( $response ) ) {
@@ -348 +349 @@
         do_action( 'rest_after_insert_attachment', $attachment, $request, false );
 
-        wp_after_insert_post( $attachment, true );
+        wp_after_insert_post( $attachment, true, $attachment_before );
 
         $response = $this->prepare_item_for_response( $attachment, $request );

branches/5.6/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

@@ -678 +678 @@
         do_action( "rest_after_insert_{$this->post_type}", $post, $request, true );
 
-        wp_after_insert_post( $post, false );
+        wp_after_insert_post( $post, false, null );
 
         $response = $this->prepare_item_for_response( $post, $request );
@@ -754 +754 @@
         }
 
-        $post = $this->prepare_item_for_database( $request );
+        $post_before = get_post( $request['id'] );
+        $post        = $this->prepare_item_for_database( $request );
 
         if ( is_wp_error( $post ) ) {
@@ -831 +832 @@
         do_action( "rest_after_insert_{$this->post_type}", $post, $request, false );
 
-        wp_after_insert_post( $post, true );
+        wp_after_insert_post( $post, true, $post_before );
 
         $response = $this->prepare_item_for_response( $post, $request );