comment_excerpt( int|WP_Comment $comment_ID )
Displays the excerpt of the current comment.
Parameters
-
$comment_ID
int|WP_Comment Required -
WP_Comment or ID of the comment for which to print the excerpt.
Default current comment.
Source
File: wp-includes/comment-template.php
.
View all references
function comment_excerpt( $comment_ID = 0 ) {
$comment = get_comment( $comment_ID );
$comment_excerpt = get_comment_excerpt( $comment );
/**
* Filters the comment excerpt for display.
*
* @since 1.2.0
* @since 4.1.0 The `$comment_ID` parameter was added.
*
* @param string $comment_excerpt The comment excerpt text.
* @param string $comment_ID The comment ID as a numeric string.
*/
echo apply_filters( 'comment_excerpt', $comment_excerpt, $comment->comment_ID );
}
Hooks
-
apply_filters( 'comment_excerpt',
string $comment_excerpt ,string $comment_ID ) -
Filters the comment excerpt for display.
Changelog
Version | Description |
---|---|
4.4.0 | Added the ability for $comment_ID to also accept a WP_Comment object. |
1.2.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Example