get_comment_time( string $format = '', bool $gmt = false, bool $translate = true, int|WP_Comment $comment_id = 0 ): string
- Since
- 1.5.0, 6.2.0
- Source
wp-includes/comment-template.php:1111
Compatibility
- WordPress
- since 6.2.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
$formatstringoptional- PHP date format. Defaults to the 'time_format' option.Default:
'' $gmtbooloptional- Whether to use the GMT date. Default false.Default:
false $translatebooloptional- Whether to translate the time (for use in feeds).
Default true.Default:true $comment_idint|WP_Commentoptional- WP_Comment or ID of the comment for which to get the time.
Default current comment.Default:0
Return value
string- The formatted time.
Performance profile
How much work a call to get_comment_time() 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
- Moderate
- Scaling
- Constant
- Instructions
- 11–36
- Plugin surface
- 1 hook
- Called by
- 8
Reads stored settings via get_option(), cached per request but not free on a cold cache.
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 40.
Third-party callbacks on 'get_comment_time' run inside this call, and their cost is not bounded by anything here.
8 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- optionoption read or write
get_option()called directly - hookthird-party callbacks
apply_filters()called directly - cacheobject cache
wp_cache_get()one call below get_comment_time() - serializeserialisation
maybe_unserialize()one call below get_comment_time()
Further down the call graph this can also reach query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_comment_time() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$comment === null | 11 | get_comment() |
$comment !== null && !empty($format) | 33–34 | get_comment(), mysql2date(), apply_filters() |
$comment !== null && empty($format) | 35–36 | get_comment(), get_option(), mysql2date(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 39 | 11–35 | 3 | 1 fewer instruction than PHP 8.5 |
| 8.5 | 40 | 11–36 | 3 | |
| 8.4 | 40 | 11–36 | 3 | |
| 8.3 | 40 | 11–36 | 3 | |
| 8.2 | 40 | 11–36 | 3 | |
| 8.1 | 40 | 11–36 | 3 | 2 fewer instructions than PHP 7.4 |
| 7.4 | 42 | 11–37 | 3 |
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_time() runs, in this order:
- apply_filters( get_comment_time )filterline 1135 (+24 into the body)
Filters the returned comment time.
Uses · 4
- get_comment()Retrieves comment data given a comment ID or comment object.
- get_option()Retrieves an option value based on an option name.
- mysql2date()Converts given MySQL date string into a different format.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 8
- TwentyNineteen_Walker_Comment::html5_comment()Outputs a comment in the HTML5 format.
- TwentyTwenty_Walker_Comment::html5_comment()Outputs a comment in the HTML5 format.
- Walker_Comment::comment()Outputs a single comment.
- Walker_Comment::html5_comment()Outputs a comment in the HTML5 format.
- comment_time()Displays the comment time of the current comment.
- twentyeleven_comment()Template for comments and pingbacks.
- twentyten_comment()Template for comments and pingbacks.
- twentytwelve_comment()Template for comments and pingbacks.
Source code
function get_comment_time( $format = '', $gmt = false, $translate = true, $comment_id = 0 ) { $comment = get_comment( $comment_id ); if ( null === $comment ) { return ''; } $comment_date = $gmt ? $comment->comment_date_gmt : $comment->comment_date; $_format = ! empty( $format ) ? $format : get_option( 'time_format' ); $comment_time = mysql2date( $_format, $comment_date, $translate ); /** * Filters the returned comment time. * * @since 1.5.0 * * @param string|int $comment_time The comment time, formatted as a date string or Unix timestamp. * @param string $format PHP date format. * @param bool $gmt Whether the GMT date is in use. * @param bool $translate Whether the time is translated. * @param WP_Comment $comment The comment object. */ return apply_filters( 'get_comment_time', $comment_time, $format, $gmt, $translate, $comment );}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.
$comment_id parameter.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 6.8.8 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.