On this page
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 );
}
Related
Uses
| Uses | Description |
|---|---|
| get_metadata() wp-includes/meta.php | Retrieves the value of a metadata field for the specified object type and ID. |
Used By
| Used By | Description |
|---|---|
| WP_Comments_List_Table::handle_row_actions() wp-admin/includes/class-wp-comments-list-table.php | Generates and displays row actions links. |
| wp_unspam_comment() wp-includes/comment.php | Removes a comment from the Spam. |
| wp_untrash_comment() wp-includes/comment.php | Removes a comment from the Trash |
Changelog
| Version | Description |
|---|---|
| 2.9.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_comment_meta