Changeset 43737

Timestamp:

10/17/2018 11:19:02 AM (6 years ago)

Author:

danielbachhuber

Message:

REST API: Fire actions after items are completely updated/inserted.

The existing rest_insert_* actions are fired before meta and additional fields are updated. These new rest_after_* actions fire after all write operations have completed.

Props timothyblynjacobs.
Fixes #42864.

Location:

branches/5.0/src/wp-includes/rest-api/endpoints

Files:

• class-wp-rest-attachments-controller.php (modified) (2 diffs)
• class-wp-rest-comments-controller.php (modified) (2 diffs)
• class-wp-rest-posts-controller.php (modified) (2 diffs)
• class-wp-rest-terms-controller.php (modified) (2 diffs)
• class-wp-rest-users-controller.php (modified) (2 diffs)

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

@@ -186 +186 @@
 
         $request->set_param( 'context', 'edit' );
+
+        /**
+         * Fires after a single attachment is completely created or updated via the REST API.
+         *
+         * @since 5.0.0
+         *
+         * @param WP_Post         $attachment Inserted or updated attachment object.
+         * @param WP_REST_Request $request    Request object.
+         * @param bool            $creating   True when creating an attachment, false when updating.
+         */
+        do_action( 'rest_after_insert_attachment', $attachment, $request, true );
+
         $response = $this->prepare_item_for_response( $attachment, $request );
         $response = rest_ensure_response( $response );
@@ -232 +244 @@
 
         $request->set_param( 'context', 'edit' );
+
+        /** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php */
+        do_action( 'rest_after_insert_attachment', $attachment, $request, false );
+
         $response = $this->prepare_item_for_response( $attachment, $request );
         $response = rest_ensure_response( $response );

branches/5.0/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

@@ -623 +623 @@
 
         $context = current_user_can( 'moderate_comments' ) ? 'edit' : 'view';
-
         $request->set_param( 'context', $context );
+
+        /**
+         * Fires completely after a comment is created or updated via the REST API.
+         *
+         * @since 5.0.0
+         *
+         * @param WP_Comment      $comment  Inserted or updated comment object.
+         * @param WP_REST_Request $request  Request object.
+         * @param bool            $creating True when creating a comment, false
+         *                                  when updating.
+         */
+        do_action( 'rest_after_insert_comment', $comment, $request, true );
 
         $response = $this->prepare_item_for_response( $comment, $request );
@@ -747 +758 @@
 
         $request->set_param( 'context', 'edit' );
+
+        /** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php */
+        do_action( 'rest_after_insert_comment', $comment, $request, false );
 
         $response = $this->prepare_item_for_response( $comment, $request );

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

@@ -601 +601 @@
         $request->set_param( 'context', 'edit' );
 
+        /**
+         * Fires after a single post is completely created or updated via the REST API.
+         *
+         * The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
+         *
+         * @since 5.0.0
+         *
+         * @param WP_Post         $post     Inserted or updated post object.
+         * @param WP_REST_Request $request  Request object.
+         * @param bool            $creating True when creating a post, false when updating.
+         */
+        do_action( "rest_after_insert_{$this->post_type}", $post, $request, true );
+
         $response = $this->prepare_item_for_response( $post, $request );
         $response = rest_ensure_response( $response );
@@ -726 +739 @@
 
         $request->set_param( 'context', 'edit' );
+
+        /** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php */
+        do_action( "rest_after_insert_{$this->post_type}", $post, $request, false );
 
         $response = $this->prepare_item_for_response( $post, $request );

branches/5.0/src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

@@ -457 +457 @@
         $request->set_param( 'context', 'view' );
 
+        /**
+         * Fires after a single term is completely created or updated via the REST API.
+         *
+         * The dynamic portion of the hook name, `$this->taxonomy`, refers to the taxonomy slug.
+         *
+         * @since 5.0.0
+         *
+         * @param WP_Term         $term     Inserted or updated term object.
+         * @param WP_REST_Request $request  Request object.
+         * @param bool            $creating True when creating a term, false when updating.
+         */
+        do_action( "rest_after_insert_{$this->taxonomy}", $term, $request, true );
+
         $response = $this->prepare_item_for_response( $term, $request );
         $response = rest_ensure_response( $response );
@@ -545 +558 @@
 
         $request->set_param( 'context', 'view' );
+
+        /** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php */
+        do_action( "rest_after_insert_{$this->taxonomy}", $term, $request, false );
 
         $response = $this->prepare_item_for_response( $term, $request );

branches/5.0/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php

@@ -556 +556 @@
         $request->set_param( 'context', 'edit' );
 
+        /**
+         * Fires after a user is completely created or updated via the REST API.
+         *
+         * @since 5.0.0
+         *
+         * @param WP_User         $user     Inserted or updated user object.
+         * @param WP_REST_Request $request  Request object.
+         * @param bool            $creating True when creating a user, false when updating.
+         */
+        do_action( 'rest_after_insert_user', $user, $request, true );
+
         $response = $this->prepare_item_for_response( $user, $request );
         $response = rest_ensure_response( $response );
@@ -678 +689 @@
 
         $request->set_param( 'context', 'edit' );
+
+        /** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php */
+        do_action( 'rest_after_insert_user', $user, $request, false );
 
         $response = $this->prepare_item_for_response( $user, $request );