WP_REST_Comments_Controller::update_item( WP_REST_Request $request ): WP_REST_Response|WP_Error

Parameters

$requestWP_REST_Request

Full details about the request.

Return

WP_REST_Response|WP_Error

Response object on success, or error object on failure.

Hooks fired · 2

2 hooks fire while WP_REST_Comments_Controller::update_item() runs, in this order:

1. 1
   do_action( rest_insert_comment )actionline 902 (+89 into the body)

   Fires after a comment is created or updated via the REST API.

2. 2
   do_action( rest_after_insert_comment )actionline 923 (+110 into the body)

   Fires completely after a comment is created or updated via the REST API.

Uses · 17

• is_wp_error()Checks whether the given variable is a WordPress Error.
• get_comment_type()Retrieves the comment type of the current comment.
• __()Retrieves the translation of $text.
• get_post()Retrieves post data given a post ID or post object.
• wp_check_comment_data_max_lengths()Compares the lengths of comment data against the maximum character limits.
• wp_update_comment()Updates an existing comment in the database.
• wp_slash()Adds slashes to a string or recursively adds slashes to strings within an array.
• get_comment()Retrieves comment data given a comment ID or comment object.
• do_action()Calls the callback functions that have been added to an action hook.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• WP_REST_Comments_Controller::get_comment()Get the comment, if the ID is valid.
• WP_Error::__construct()Initializes the error.

Source

View on Trac ↗View on GitHub ↗

813	public function update_item( $request ) {814		$comment = $this->get_comment( $request['id'] );815		if ( is_wp_error( $comment ) ) {816			return $comment;817		}818 819		$id = $comment->comment_ID;820 821		if ( isset( $request['type'] ) && get_comment_type( $id ) !== $request['type'] ) {822			return new WP_Error(823				'rest_comment_invalid_type',824				__( 'Sorry, you are not allowed to change the comment type.' ),825				array( 'status' => 404 )826			);827		}828 829		$prepared_args = $this->prepare_item_for_database( $request );830 831		if ( is_wp_error( $prepared_args ) ) {832			return $prepared_args;833		}834 835		if ( ! empty( $prepared_args['comment_post_ID'] ) ) {836			$post = get_post( $prepared_args['comment_post_ID'] );837 838			if ( empty( $post ) ) {839				return new WP_Error(840					'rest_comment_invalid_post_id',841					__( 'Invalid post ID.' ),842					array( 'status' => 403 )843				);844			}845		}846 847		if ( empty( $prepared_args ) && isset( $request['status'] ) ) {848			// Only the comment status is being changed.849			$change = $this->handle_status_param( $request['status'], $id );850 851			if ( ! $change ) {852				return new WP_Error(853					'rest_comment_failed_edit',854					__( 'Updating comment status failed.' ),855					array( 'status' => 500 )856				);857			}858		} elseif ( ! empty( $prepared_args ) ) {859			if ( is_wp_error( $prepared_args ) ) {860				return $prepared_args;861			}862 863			if ( isset( $prepared_args['comment_content'] ) && empty( $prepared_args['comment_content'] ) ) {864				return new WP_Error(865					'rest_comment_content_invalid',866					__( 'Invalid comment content.' ),867					array( 'status' => 400 )868				);869			}870 871			$prepared_args['comment_ID'] = $id;872 873			$check_comment_lengths = wp_check_comment_data_max_lengths( $prepared_args );874 875			if ( is_wp_error( $check_comment_lengths ) ) {876				$error_code = $check_comment_lengths->get_error_code();877				return new WP_Error(878					$error_code,879					__( 'Comment field exceeds maximum length allowed.' ),880					array( 'status' => 400 )881				);882			}883 884			$updated = wp_update_comment( wp_slash( (array) $prepared_args ), true );885 886			if ( is_wp_error( $updated ) ) {887				return new WP_Error(888					'rest_comment_failed_edit',889					__( 'Updating comment failed.' ),890					array( 'status' => 500 )891				);892			}

History

Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.