wppaste
WordPress

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

Since
2.9.0
Source
wp-includes/comment.php:581
Retrieves comment meta field for a comment.

Parameters

$comment_idint
Comment ID.
$keystringoptional
The meta key to retrieve. By default, returns data for all keys. Default empty string.Default: ''
$singlebooloptional
Whether to return a single value. This parameter has no effect if $key is not specified. Default false.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.

Uses · 1

  • get_metadata()Retrieves the value of a metadata field for the specified object type and ID.

Used by · 3

Source

View on Trac View on GitHub 

function get_comment_meta( $comment_id, $key = '', $single = false ) {	return get_metadata( 'comment', $comment_id, $key, $single );}

History

Introduced in 2.9.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/comment.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.