get_comment_meta( int $comment_id, string $key = '', bool $single = false ): mixed
Retrieves comment meta field for a comment.
Parameters
-
$comment_idint Required -
Comment ID.
-
$keystring Optional -
The meta key to retrieve. By default, returns data for all keys.
Default:
'' -
$singlebool Optional -
Whether to return a single value.
This parameter has no effect if$keyis 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 string if a valid but non-existing comment ID is passed.
Source
File: wp-includes/comment.php.
View all references
function get_comment_meta( $comment_id, $key = '', $single = false ) {
return get_metadata( 'comment', $comment_id, $key, $single );
}
Changelog
| Version | Description |
|---|---|
| 2.9.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Basic Example