get_comment_meta() WP 1.0

Retrieve comment meta field for a comment.

No Hooks.

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.

Usage

get_comment_meta( $comment_id, $key, $single );

$comment_id(int) (required)

Comment ID.

$key(string)

The meta key to retrieve. By default, returns data for all keys.
Default: ''

$single(true|false)

Whether to return a single value. This parameter has no effect if $key is not specified.
Default: false

Changelog

Code of get_comment_meta() get comment meta ^{WP 5.8.1}

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

Related Functions

Metadatas (any)