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

Retrieve comment meta field for a comment.


Description Description


Parameters Parameters

$comment_id

(int) (Required) Comment ID.

$key

(string) (Optional) The meta key to retrieve. By default, returns data for all keys.

Default value: ''

$single

(bool) (Optional) Whether to return a single value.

Default value: false


Top ↑

Return Return

(mixed) Will be an array if $single is false. Will be value of meta data field if $single is true.


Top ↑

Source Source

File: wp-includes/comment.php

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

Top ↑

Changelog Changelog

Changelog
Version Description
2.9.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

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