get_comment_excerpt( int|WP_Comment $comment_id = 0 ): string
- Since
- 1.5.0, 4.4.0
- Source
wp-includes/comment-template.php:658
Description
Returns a maximum of 20 words with an ellipsis appended if necessary.
Compatibility
- WordPress
- since 4.4.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|WP_Commentoptional- WP_Comment or ID of the comment for which to get the excerpt.
Default current comment.Default:0
Return value
string- The possibly truncated comment excerpt.
Performance profile
How much work a call to get_comment_excerpt() 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
- Heavy
- Scaling
- Constant
- Instructions
- 40–44
- Plugin surface
- 2 hooks
- Called by
- 2
Reaches the database via get_post().
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 48.
Third-party callbacks on 'comment_excerpt_length', 'get_comment_excerpt' 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 - querycontent query
get_post()one call below get_comment_excerpt() - optionoption read or write
get_option()one call below get_comment_excerpt()
Further down the call graph this can also reach cache, serialize 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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_comment_excerpt() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
post_password_required() | 40 | get_comment(), post_password_required(), __(), _x(), apply_filters(), wp_trim_words(), apply_filters() |
!post_password_required() | 44 | get_comment(), post_password_required(), strip_tags(), _x(), apply_filters(), wp_trim_words(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 48 | 40–44 | 1 | |
| 8.5 | 48 | 40–44 | 1 | |
| 8.4 | 48 | 40–44 | 1 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 51 | 40–47 | 1 | |
| 8.2 | 51 | 40–47 | 1 | |
| 8.1 | 51 | 40–47 | 1 | |
| 7.4 | 51 | 40–47 | 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 · 2
2 hooks fire while get_comment_excerpt() runs, in this order:
- apply_filters( comment_excerpt_length )filterline 677 (+19 into the body)
Filters the maximum number of words used in the comment excerpt.
- apply_filters( get_comment_excerpt )filterline 691 (+33 into the body)
Filters the retrieved comment excerpt.
Uses · 6
- get_comment()Retrieves comment data given a comment ID or comment object.
- post_password_required()Determines whether the post requires password and whether a correct password has been provided.
- __()Retrieves the translation of $text.
- _x()Retrieves translated string with gettext context.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- wp_trim_words()Trims text to a certain number of words.
Used by · 2
- comment_excerpt()Displays the excerpt of the current comment.
- render_block_core_latest_comments()Renders the `core/latest-comments` block on server.
Source code
function get_comment_excerpt( $comment_id = 0 ) { $comment = get_comment( $comment_id ); if ( ! post_password_required( $comment->comment_post_ID ) ) { $comment_text = strip_tags( str_replace( array( "\n", "\r" ), ' ', $comment->comment_content ) ); } else { $comment_text = __( 'Password protected' ); } /* translators: Maximum number of words used in a comment excerpt. */ $comment_excerpt_length = (int) _x( '20', 'comment_excerpt_length' ); /** * Filters the maximum number of words used in the comment excerpt. * * @since 4.4.0 * * @param int $comment_excerpt_length The amount of words you want to display in the comment excerpt. */ $comment_excerpt_length = apply_filters( 'comment_excerpt_length', $comment_excerpt_length ); $comment_excerpt = wp_trim_words( $comment_text, $comment_excerpt_length, '…' ); /** * Filters the retrieved comment excerpt. * * @since 1.5.0 * @since 4.1.0 The `$comment_id` and `$comment` parameters were added. * * @param string $comment_excerpt The comment excerpt text. * @param string $comment_id The comment ID as a numeric string. * @param WP_Comment $comment The comment object. */ return apply_filters( 'get_comment_excerpt', $comment_excerpt, $comment->comment_ID, $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 to also accept a WP_Comment object.from the docblockAbout 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.