W3cubDocs

/WordPress

WP_REST_Comments_Controller::get_item( WP_REST_Request $request )

Retrieves a comment.

Parameters

$request

(WP_REST_Request) (Required) Full details about the request.

Return

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

Source

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

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;
	}

Uses

Uses Description
wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php: WP_REST_Comments_Controller::get_comment()

Get the comment, if the ID is valid.
wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php: WP_REST_Comments_Controller::prepare_item_for_response()

Prepares a single comment output for response.
wp-includes/rest-api.php: rest_ensure_response()

Ensures a REST response is a response object (for consistency).
wp-includes/load.php: is_wp_error()

Check whether variable is a WordPress Error.

Changelog

Version Description
4.7.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_comments_controller/get_item