IntenseWebs/WordPress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

REST API: Always fire the rest_insert_* actions after the related object is updated or inserted.

Browse Source 
Brings consistency to the `rest_insert_*` actions. Also includes some shuffling and clean-up as well including:
- Ensure we are passing the most current `$post` and `$user` objects to the `update_additional_fields_for_object()` callbacks.
- Changes the function signature of `handle_status_param()` in the Comments controller to accept just the comment_id as the 2nd parameter, instead of a full WP_Comment object. Only the comment_id is needed in the method, this avoids having to include another `get_comment()` call. 
- Renames a variable in the `create_item()` method of the Posts controller from `$post` -> `$prepared_post` to be more explicit.
- Minor fixes/clarifications to the rest_insert_* hook docs

Props rachelbaker, joehoyle
Fixes #38905.
Built from https://develop.svn.wordpress.org/trunk@39348


git-svn-id: http://core.svn.wordpress.org/trunk@39288 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Rachel Baker
2016-11-23 15:33:31 +00:00
parent 98e8bf7ba2
commit a985a4d126
6 changed files with 97 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php
View File

@@ -567,11 +567,23 @@ class WP_REST_Comments_Controller extends WP_REST_Controller {
}
if ( isset( $request['status'] ) ) {
$comment = get_comment( $comment_id );
$this->handle_status_param( $request['status'], $comment );
$this->handle_status_param( $request['status'], $comment_id );
}
$comment = get_comment( $comment_id );
/**
* Fires after a comment is created or updated via the REST API.
*
* @since 4.7.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_insert_comment', $comment, $request, true );
$schema = $this->get_item_schema();
if ( ! empty( $schema['properties']['meta'] ) && isset( $request['meta'] ) ) {
@@ -582,8 +594,6 @@ class WP_REST_Comments_Controller extends WP_REST_Controller {
}
}
$comment = get_comment( $comment_id );
$fields_update = $this->update_additional_fields_for_object( $comment, $request );
if ( is_wp_error( $fields_update ) ) {
@@ -600,16 +610,6 @@ class WP_REST_Comments_Controller extends WP_REST_Controller {
$response->set_status( 201 );
$response->header( 'Location', rest_url( sprintf( '%s/%s/%d', $this->namespace, $this->rest_base, $comment_id ) ) );
/**
* Fires after a comment is created or updated via the REST API.
*
* @since 4.7.0
*
* @param array $comment Comment as it exists in the database.
* @param WP_REST_Request $request The request sent to the API.
* @param bool $creating True when creating a comment, false when updating.
*/
do_action( 'rest_insert_comment', $comment, $request, true );
return $response;
}
@@ -666,7 +666,7 @@ class WP_REST_Comments_Controller extends WP_REST_Controller {
if ( empty( $prepared_args ) && isset( $request['status'] ) ) {
// Only the comment status is being changed.
$change = $this->handle_status_param( $request['status'], $comment );
$change = $this->handle_status_param( $request['status'], $id );
if ( ! $change ) {
return new WP_Error( 'rest_comment_failed_edit', __( 'Updating comment status failed.' ), array( 'status' => 500 ) );
@@ -695,10 +695,15 @@ class WP_REST_Comments_Controller extends WP_REST_Controller {
}
if ( isset( $request['status'] ) ) {
$this->handle_status_param( $request['status'], $comment );
$this->handle_status_param( $request['status'], $id );
}
}
$comment = get_comment( $id );
/* This action is documented in lib/endpoints/class-wp-rest-comments-controller.php */
do_action( 'rest_insert_comment', $comment, $request, false );
$schema = $this->get_item_schema();
if ( ! empty( $schema['properties']['meta'] ) && isset( $request['meta'] ) ) {
@@ -709,8 +714,6 @@ class WP_REST_Comments_Controller extends WP_REST_Controller {
}
}
$comment = get_comment( $id );
$fields_update = $this->update_additional_fields_for_object( $comment, $request );
if ( is_wp_error( $fields_update ) ) {
@@ -721,9 +724,6 @@ class WP_REST_Comments_Controller extends WP_REST_Controller {
$response = $this->prepare_item_for_response( $comment, $request );
/* This action is documented in lib/endpoints/class-wp-rest-comments-controller.php */
do_action( 'rest_insert_comment', $comment, $request, false );
return rest_ensure_response( $response );
}
@@ -1433,11 +1433,11 @@ class WP_REST_Comments_Controller extends WP_REST_Controller {
* @access protected
*
* @param string|int $new_status New comment status.
* @param WP_Comment $comment Comment data.
* @param int $comment_id Comment ID.
* @return bool Whether the status was changed.
*/
protected function handle_status_param( $new_status, $comment ) {
$old_status = wp_get_comment_status( $comment->comment_ID );
protected function handle_status_param( $new_status, $comment_id ) {
$old_status = wp_get_comment_status( $comment_id );
if ( $new_status === $old_status ) {
return false;
@@ -1447,23 +1447,23 @@ class WP_REST_Comments_Controller extends WP_REST_Controller {
case 'approved' :
case 'approve':
case '1':
$changed = wp_set_comment_status( $comment->comment_ID, 'approve' );
$changed = wp_set_comment_status( $comment_id, 'approve' );
break;
case 'hold':
case '0':
$changed = wp_set_comment_status( $comment->comment_ID, 'hold' );
$changed = wp_set_comment_status( $comment_id, 'hold' );
break;
case 'spam' :
$changed = wp_spam_comment( $comment->comment_ID );
$changed = wp_spam_comment( $comment_id );
break;
case 'unspam' :
$changed = wp_unspam_comment( $comment->comment_ID );
$changed = wp_unspam_comment( $comment_id );
break;
case 'trash' :
$changed = wp_trash_comment( $comment->comment_ID );
$changed = wp_trash_comment( $comment_id );
break;
case 'untrash' :
$changed = wp_untrash_comment( $comment->comment_ID );
$changed = wp_untrash_comment( $comment_id );
break;
default :
$changed = false;