get_comment( WP_Comment|string|int $comment = null, string $output = OBJECT ): WP_Comment|array|null

Retrieves comment data given a comment ID or comment object.

Contents

Description

If an object is passed then the comment data will be cached and then returned after being passed through a filter. If the comment is empty, then the global comment variable will be used, if it is set.

Top ↑

Parameters

$comment WP_Comment|string|int Optional
Comment to retrieve.

Default: null

$output string Optional
The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to a WP_Comment object, an associative array, or a numeric array, respectively.

Default: OBJECT

Top ↑

Return

WP_Comment|array|null Depends on $output value.

Top ↑

Source

File: wp-includes/comment.php. View all references 

function get_comment( $comment = null, $output = OBJECT ) {
	if ( empty( $comment ) && isset( $GLOBALS['comment'] ) ) {
		$comment = $GLOBALS['comment'];
	}

	if ( $comment instanceof WP_Comment ) {
		$_comment = $comment;
	} elseif ( is_object( $comment ) ) {
		$_comment = new WP_Comment( $comment );
	} else {
		$_comment = WP_Comment::get_instance( $comment );
	}

	if ( ! $_comment ) {
		return null;
	}

	/**
	 * Fires after a comment is retrieved.
	 *
	 * @since 2.3.0
	 *
	 * @param WP_Comment $_comment Comment data.
	 */
	$_comment = apply_filters( 'get_comment', $_comment );

	if ( OBJECT === $output ) {
		return $_comment;
	} elseif ( ARRAY_A === $output ) {
		return $_comment->to_array();
	} elseif ( ARRAY_N === $output ) {
		return array_values( $_comment->to_array() );
	}
	return $_comment;
}

View on Trac View on GitHub

Top ↑

Hooks

Top ↑

Top ↑

Used By

Used By
Used By Description
wp_get_unapproved_comment_author_email() wp-includes/comment.php

Gets unapproved comment author’s email.
get_object_subtype() wp-includes/meta.php

Returns the object subtype for a given object ID of a specific type.
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::update_item() wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

Updates 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::create_item() wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

Creates a comment.
WP_Comment_Query::fill_descendants() wp-includes/class-wp-comment-query.php

Fetch descendants for located comments.
wp_handle_comment_submission() wp-includes/comment.php

Handles the submission of a comment, usually posted to wp-comments-post.php via a comment form.
wp_new_comment_notify_moderator() wp-includes/comment.php

Sends a comment moderation notification to the comment moderator.
wp_new_comment_notify_postauthor() wp-includes/comment.php

Sends a notification of a new comment to the post author.
WP_Comments_List_Table::floated_admin_avatar() wp-admin/includes/class-wp-comments-list-table.php

Adds avatars to comment author names.
WP_Comment_Query::get_comments() wp-includes/class-wp-comment-query.php

Get a list of comments matching the query vars.
get_avatar_data() wp-includes/link-template.php

Retrieves default data about the avatar.
touch_time() wp-admin/includes/template.php

Prints out HTML form date elements for editing post or comment publish date.
_wp_ajax_delete_comment_response() wp-admin/includes/ajax-actions.php

Sends back current comment total and new page links if they need to be updated.
wp_ajax_delete_comment() wp-admin/includes/ajax-actions.php

Ajax handler for deleting a comment.
wp_ajax_dim_comment() wp-admin/includes/ajax-actions.php

Ajax handler to dim a comment.
wp_ajax_get_comments() wp-admin/includes/ajax-actions.php

Ajax handler for getting comments.
wp_ajax_replyto_comment() wp-admin/includes/ajax-actions.php

Ajax handler for replying to a comment.
wp_ajax_edit_comment() wp-admin/includes/ajax-actions.php

Ajax handler for editing a comment.
WP_Comments_List_Table::column_comment() wp-admin/includes/class-wp-comments-list-table.php
get_comment_to_edit() wp-admin/includes/comment.php

Returns a WP_Comment object based on comment ID.
floated_admin_avatar() wp-admin/includes/comment.php

Adds avatars to relevant places in admin.
map_meta_cap() wp-includes/capabilities.php

Maps a capability to the primitive capabilities required of the given user to satisfy the capability being checked.
get_avatar() wp-includes/pluggable.php

Retrieves the avatar <img> tag for a user, email address, MD5 hash, comment, or post.
wp_notify_postauthor() wp-includes/pluggable.php

Notifies an author (and/or others) of a comment/trackback/pingback on a post.
wp_notify_moderator() wp-includes/pluggable.php

Notifies the moderator of the site about a new comment that is awaiting approval.
get_commentdata() wp-includes/deprecated.php

Retrieve an array of comment data about comment $comment_ID.
wp_scheduled_delete() wp-includes/functions.php

Permanently deletes comments or posts of any type that have held a status of ‘trash’ for the number of days defined in EMPTY_TRASH_DAYS.
get_edit_comment_link() wp-includes/link-template.php

Retrieves the edit comment link.
edit_comment_link() wp-includes/link-template.php

Displays the edit comment link with formatting.
get_comment_guid() wp-includes/feed.php

Retrieves the feed GUID for the current comment.
wp_xmlrpc_server::wp_deleteComment() wp-includes/class-wp-xmlrpc-server.php

Delete a comment.
wp_xmlrpc_server::wp_editComment() wp-includes/class-wp-xmlrpc-server.php

Edit comment.
wp_xmlrpc_server::wp_getComment() wp-includes/class-wp-xmlrpc-server.php

Retrieve comment.
comment_form_title() wp-includes/comment-template.php

Displays text based on comment reply status.
get_comment_reply_link() wp-includes/comment-template.php

Retrieves HTML content for reply to comment link.
get_comment_link() wp-includes/comment-template.php

Retrieves the link to a given comment.
get_comment_text() wp-includes/comment-template.php

Retrieves the text of the current comment.
comment_text() wp-includes/comment-template.php

Displays the text of the current comment.
get_comment_time() wp-includes/comment-template.php

Retrieves the comment time of the current comment.
get_comment_type() wp-includes/comment-template.php

Retrieves the comment type of the current comment.
comment_author_url() wp-includes/comment-template.php

Displays the URL of the author of the current comment, not linked.
get_comment_class() wp-includes/comment-template.php

Returns the classes for the comment div as an array.
get_comment_date() wp-includes/comment-template.php

Retrieves the comment date of the current comment.
get_comment_excerpt() wp-includes/comment-template.php

Retrieves the excerpt of the given comment.
comment_excerpt() wp-includes/comment-template.php

Displays the excerpt of the current comment.
get_comment_ID() wp-includes/comment-template.php

Retrieves the comment ID of the current comment.
get_comment_author() wp-includes/comment-template.php

Retrieves the author of the current comment.
comment_author() wp-includes/comment-template.php

Displays the author of the current comment.
get_comment_author_email() wp-includes/comment-template.php

Retrieves the email of the author of the current comment.
comment_author_email() wp-includes/comment-template.php

Displays the email of the author of the current global $comment.
get_comment_author_email_link() wp-includes/comment-template.php

Returns the HTML email link to the author of the current comment.
get_comment_author_link() wp-includes/comment-template.php

Retrieves the HTML link to the URL of the author of the current comment.
get_comment_author_IP() wp-includes/comment-template.php

Retrieves the IP address of the author of the current comment.
get_comment_author_url() wp-includes/comment-template.php

Retrieves the URL of the author of the current comment, not linked.
wp_set_comment_status() wp-includes/comment.php

Sets the status of a comment.
wp_update_comment() wp-includes/comment.php

Updates an existing comment in the database.
wp_spam_comment() wp-includes/comment.php

Marks a comment as Spam.
wp_unspam_comment() wp-includes/comment.php

Removes a comment from the Spam.
wp_get_comment_status() wp-includes/comment.php

Retrieves the status of a comment by comment ID.
wp_insert_comment() wp-includes/comment.php

Inserts a comment into the database.
get_page_of_comment() wp-includes/comment.php

Calculates what page number a comment will appear on for comment paging.
wp_delete_comment() wp-includes/comment.php

Trashes or deletes a comment.
wp_trash_comment() wp-includes/comment.php

Moves a comment to the Trash
wp_untrash_comment() wp-includes/comment.php

Removes a comment from the Trash
Show 61 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
2.0.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Example
    To get the author’s name of a comment with ID 7:

    <?php
$my_id = 7;
$comment_id_7 = get_comment( $my_id ); 
$name = $comment_id_7->comment_author;
?>

    Alternatively, specify the $output parameter:

    <?php
$my_id = 7;
$comment_id_7 = get_comment( $my_id, ARRAY_A );
$name = $comment_id_7['comment_author'];
?>
    <?php
//	Correct: pass a dummy variable as post_id
$the_comment = & get_comment( $dummy_id = 7 );
	
//	Incorrect: literal integer as post_id
$the_comment = & get_comment( 7 );
//	Fatal error: 'Only variables can be passed for reference' or 'Cannot pass parameter 1 by reference'
?>
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Example
    To get the author’s name of a comment with ID 7:

    <?php
$my_id = 7;
$comment_id_7 = get_comment( $my_id ); 
$name = $comment_id_7->comment_author;
?>
[php]
Alternatively, specify the <code>$output</code> parameter:

[php]
<?php
$my_id = 7;
$comment_id_7 = get_comment( $my_id, ARRAY_A );
$name = $comment_id_7['comment_author'];
?>
    <?php
//	Correct: pass a dummy variable as post_id
$the_comment = & get_comment( $dummy_id = 7 );
	
//	Incorrect: literal integer as post_id
$the_comment = & get_comment( 7 );
//	Fatal error: 'Only variables can be passed for reference' or 'Cannot pass parameter 1 by reference'
?>

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