WP_REST_Comments_Controller::get_item() – Method

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

Retrieves a comment.

Parameters

$requestWP_REST_Requestrequired: Full details about the request.

Return

WP_REST_Response|WP_Error Response object on success, or error object on failure.

Source

public function get_item( $request ) {
	$comment = $this->get_comment( $request['id'] );
	if ( is_wp_error( $comment ) ) {
		return $comment;
	}

	$data     = $this->prepare_item_for_response( $comment, $request );
	$response = rest_ensure_response( $data );

	return $response;
}

View all references View on Trac View on GitHub

Uses	Description
WP_REST_Comments_Controller::get_comment()`wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php`	Get the comment, if the ID is valid.
WP_REST_Comments_Controller::prepare_item_for_response()`wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php`	Prepares a single comment output for response.
rest_ensure_response()`wp-includes/rest-api.php`	Ensures a REST response is a response object (for consistency).
is_wp_error()`wp-includes/load.php`	Checks whether the given variable is a WordPress Error.

Show 2 more Show less

Changelog

Version	Description
4.7.0	Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.