get_comment_meta

函数


get_comment_meta ( $comment_id, $key = '', $single = false )
参数
  • (int)
    $comment_id
    Comment ID.
    Required:
  • (string)
    $key
    Optional. The meta key to retrieve. By default, returns data for all keys.
    Required:
    Default: (empty)
  • (bool)
    $single
    Optional. Whether to return a single value. This parameter has no effect if `$key` is not specified. Default false.
    Required:
    Default: false
返回值
  • (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.
定义位置
  • wp-includes/comment.php
    , line 477
引入
2.9.0
弃用

Retrieves comment meta field for a comment.

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