WP_REST_Comments_Controller::get_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.

Uses · 4

• is_wp_error()Checks whether the given variable is a WordPress Error.
• 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_REST_Comments_Controller::prepare_item_for_response()Prepares a single comment output for response.

Source

View on Trac ↗View on GitHub ↗

479	public function get_item( $request ) {480		$comment = $this->get_comment( $request['id'] );481		if ( is_wp_error( $comment ) ) {482			return $comment;483		}484 485		$data     = $this->prepare_item_for_response( $comment, $request );486		$response = rest_ensure_response( $data );487 488		return $response;489	}

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 7.1.0 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.