From 82a863236784a3554f7c3ce9c8306f44c0aabb70 Mon Sep 17 00:00:00 2001 From: Jonathan Desrosiers Date: Wed, 12 Dec 2018 21:11:27 +0000 Subject: [PATCH] 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, danielbachhuber. Merges [43737] to trunk. Fixes #42864. git-svn-id: https://develop.svn.wordpress.org/trunk@43987 602fd350-edb4-49c9-b593-d223f7449a82 --- .../class-wp-rest-attachments-controller.php | 16 ++++++++++++++++ .../class-wp-rest-comments-controller.php | 16 +++++++++++++++- .../endpoints/class-wp-rest-posts-controller.php | 16 ++++++++++++++++ .../endpoints/class-wp-rest-terms-controller.php | 16 ++++++++++++++++ .../endpoints/class-wp-rest-users-controller.php | 14 ++++++++++++++ 5 files changed, 77 insertions(+), 1 deletion(-) diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php index 4707dd4a62..2612f66c9f 100644 --- a/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php +++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php @@ -188,6 +188,18 @@ class WP_REST_Attachments_Controller extends WP_REST_Posts_Controller { } $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 ); $response->set_status( 201 ); @@ -234,6 +246,10 @@ class WP_REST_Attachments_Controller extends WP_REST_Posts_Controller { } $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 ); diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php index 05227a1d5f..f673450d41 100644 --- a/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php +++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php @@ -633,9 +633,20 @@ class WP_REST_Comments_Controller extends WP_REST_Controller { } $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 ); $response = rest_ensure_response( $response ); @@ -757,6 +768,9 @@ class WP_REST_Comments_Controller extends WP_REST_Controller { $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 ); return rest_ensure_response( $response ); diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php index 93b6608e7a..5002484ed8 100644 --- a/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php +++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php @@ -608,6 +608,19 @@ class WP_REST_Posts_Controller extends WP_REST_Controller { $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 ); @@ -734,6 +747,9 @@ class WP_REST_Posts_Controller extends WP_REST_Controller { $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 ); return rest_ensure_response( $response ); diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php index 884e5f60f3..ff399cc60e 100644 --- a/src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php +++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php @@ -469,6 +469,19 @@ class WP_REST_Terms_Controller extends WP_REST_Controller { $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 ); @@ -558,6 +571,9 @@ class WP_REST_Terms_Controller extends WP_REST_Controller { $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 ); return rest_ensure_response( $response ); diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php index ec3f9ea204..6c9611c87b 100644 --- a/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php +++ b/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php @@ -566,6 +566,17 @@ class WP_REST_Users_Controller extends WP_REST_Controller { $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 ); @@ -689,6 +700,9 @@ class WP_REST_Users_Controller extends WP_REST_Controller { $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 ); $response = rest_ensure_response( $response );