get_comment_meta( int $comment_id, string $key = '', bool $single = false )
Retrieve comment meta field for a comment.
Description
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.
Default value: false
Return
(mixed) Will be an array if $single is false. Will be value of meta data field if $single is true.
Source
File: wp-includes/comment.php
function get_comment_meta( $comment_id, $key = '', $single = false ) {
return get_metadata( 'comment', $comment_id, $key, $single );
}
Changelog
| Version | Description |
|---|---|
| 2.9.0 | Introduced. |
Basic Example