get_comment_meta() WordPress Function
The get_comment_meta() function enables you to retrieve comment meta field data for a given comment ID. This function is typically used within the comments loop to display comment meta data for each individual comment.
get_comment_meta( int $comment_id, string $key = '', bool $single = false ) #
Retrieves comment meta field for a comment.
Parameters
- $comment_id
(int)(Required)Comment ID.
- $key
(string)(Optional) The meta key to retrieve. By default, returns data for all keys.
Default value: ''
- $single
(bool)(Optional) Whether to return a single value. This parameter has no effect if
$keyis 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 full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.9.0 | Introduced. |