get_comment_ID(): string
- Since
- 1.5.0
- Source
wp-includes/comment-template.php:727
Compatibility
- WordPress
- since 1.5.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.
Return value
string- The comment ID as a numeric string.
Performance profile
How much work a call to get_comment_ID() 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
- Scaling
- Constant
- Instructions
- 13–14
- Plugin surface
- 1 hook
- Called by
- 2
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 15.
Third-party callbacks on 'get_comment_ID' run inside this call, and their cost is not bounded by anything here.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly
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_ID() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 13–14 | get_comment(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 15 | 13–14 | 1 | |
| 8.5 | 15 | 13–14 | 1 | |
| 8.4 | 15 | 13–14 | 1 | |
| 8.3 | 15 | 13–14 | 1 | |
| 8.2 | 15 | 13–14 | 1 | |
| 8.1 | 15 | 13–14 | 1 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 16 | 13–15 | 1 |
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.
Hooks and filters fired · 1
One hook fires while get_comment_ID() runs, in this order:
Uses · 2
- get_comment()Retrieves comment data given a comment ID or comment object.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 2
- comment_ID()Displays the comment ID of the current comment.
- comment_form_title()Displays text based on comment reply status.
Source code
function get_comment_ID() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid $comment = get_comment(); $comment_id = ! empty( $comment->comment_ID ) ? $comment->comment_ID : '0'; /** * Filters the returned comment ID. * * @since 1.5.0 * @since 4.1.0 The `$comment` parameter was added. * * @param string $comment_id The current comment ID as a numeric string. * @param WP_Comment $comment The comment object. */ return apply_filters( 'get_comment_ID', $comment_id, $comment ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.NotLowercase}Changelog
Introduced in 1.5.0. Unchanged from 6.7.7 through 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-template.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.