W3cubDocs

/WordPress

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

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

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 array if a valid but non-existing comment ID is passed and $single is false.
An empty string if a valid but non-existing comment ID is passed and $single is true.

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

Changelog

Version	Description
2.9.0	Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_comment_meta