get_comment_meta() – Retrieve comment meta field for a comment.

You appear to be a bot. Output may be restricted

Description

Retrieves comment meta field for a comment.

Usage

$mixed = get_comment_meta( $comment_id, $key, $single );

Parameters

$comment_id
( int ) required – Comment ID.
$key
( string ) optional – Optional. The meta key to retrieve. By default, returns data for all keys.
$single
( bool ) optional – Optional. Whether to return a single value. This parameter has no effect if $key is not specified. Default false.

Returns

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 name: wordpress/wp-includes/comment.php
Lines:

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

 View on GitHub View on Trac