WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Comments_Controller::get_comment()

WP_REST_Comments_Controller::get_comment( int $id ): WP_Comment|WP_Error

In this article

Back to top

Get the comment, if the ID is valid.

Parameters

$idintrequired
Supplied ID.

Return

WP_Comment|WP_Error Comment object if ID is valid, WP_Error otherwise.

Source

protected function get_comment( $id ) {	$error = new WP_Error(	'rest_comment_invalid_id',	__( 'Invalid comment ID.' ),	array( 'status' => 404 )	);	if ( (int) $id <= 0 ) {	return $error;	}	$id = (int) $id;	$comment = get_comment( $id );	if ( empty( $comment ) ) {	return $error;	}	if ( ! empty( $comment->comment_post_ID ) ) {	$post = get_post( (int) $comment->comment_post_ID );	if ( empty( $post ) ) {	return new WP_Error(	'rest_post_invalid_id',	__( 'Invalid post ID.' ),	array( 'status' => 404 )	);	}	}	return $comment; }

View all references View on Trac View on GitHub

UsesDescription
get_post()wp-includes/post.php

Retrieves post data given a post ID or post object.

get_comment()wp-includes/comment.php

Retrieves comment data given a comment ID or comment object.

WP_Error::__construct()wp-includes/class-wp-error.php

Initializes the error.

Show 1 moreShow less
Used byDescription
WP_REST_Comments_Controller::update_item_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

Checks if a given REST request has access to update a comment.

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

Updates a comment.

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

Checks if a given request has access to delete a comment.

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

Deletes a comment.

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

Checks if a given request has access to read the comment.

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

Retrieves a comment.

Show 1 moreShow less

Changelog

VersionDescription
4.7.2Introduced.

User Contributed Notes

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