get_comment_meta() – Function | Developer.WordPress.org

Retrieves comment meta field for a comment.

Parameters

$comment_idintrequired: Comment ID.
$keystringoptional: The meta key to retrieve. By default, returns data for all keys.
Default:''
$singlebooloptional: Whether to return a single value.
This parameter has no effect if $key is not specified.

Default:false

mixed An array of values if $single is false.
The value of meta data field if $single is true.
False for an invalid $comment_id (non-numeric, zero, or negative value).
An empty string if a valid but non-existing comment ID is passed.

Source

function get_comment_meta( $comment_id, $key = '', $single = false ) {
	return get_metadata( 'comment', $comment_id, $key, $single );
}

View all references View on Trac View on GitHub

Uses	Description
get_metadata()`wp-includes/meta.php`	Retrieves the value of a metadata field for the specified object type and ID.

Used by	Description
WP_Comments_List_Table::handle_row_actions()`wp-admin/includes/class-wp-comments-list-table.php`	Generates and displays row actions links.
wp_unspam_comment()`wp-includes/comment.php`	Removes a comment from the Spam.
wp_untrash_comment()`wp-includes/comment.php`	Removes a comment from the Trash

Changelog

Version	Description
2.9.0	Introduced.

User Contributed Notes

Skip to note 2 content

Codex 9 years ago

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
Basic Example
```
// Return a single meta value with the key 'vote' from a defined comment object.
$vote = get_comment_meta( $comment->comment_ID, 'vote', true );
```
Log in to add feedback

get_comment_meta( int $comment_id, string $key = ”, bool $single = false ): mixed

In this article

Parameters

Return

Source

Changelog

User Contributed Notes

get_comment_meta( int $comment_id, string $key = ”, bool $single = false ): mixed

In this article

Parameters

Return

Source

Related

Changelog

User Contributed Notes