WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_comment_meta()

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

In this article

Back to top

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.
Note: Non-serialized values are returned as strings:
  • false values are returned as empty strings ('')
  • true values are returned as '1'
  • numbers are returned as strings Arrays and objects retain their original type.

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

UsesDescription
get_metadata()wp-includes/meta.php

Retrieves the value of a metadata field for the specified object type and ID.

Used byDescription
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

VersionDescription
2.9.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.