get_comment_meta( int $comment_id, string $key = '', bool $single = false )

Retrieves comment meta field for a comment.

Parameters

$comment_id

(Required) Comment ID.

$key

(Optional) The meta key to retrieve. By default, returns data for all keys.

Default value: ''

$single

(Optional) Whether to return a single value. This parameter has no effect if $key is not specified.

Default value: false

Return

(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

File: wp-includes/comment.php

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

Expand Source Code View on GitHub

Uses

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

Used By

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

Changelog

Changelog
Version	Description
2.9.0	Introduced.