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.

Compatibility

WordPress
since 2.9.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

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 value

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.

Performance profile

How much work a call to get_comment_meta() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
10

Executed per call on PHP 8.5. The body compiles to 10.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
3

3 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_comment_meta() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always10get_metadata()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 10 instructions, 10 executed per call, 0 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 1

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

Used by · 3

Source code

View on Trac View on GitHub 

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

Changelog

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.