comment_excerpt() WordPress Function
The comment_excerpt() function in Wordpress is used to generate an excerpt for a comment. This function is similar to the WP_Comment::get_content() function, except that it also strips shortcodes and tags from the comment content. This function can be useful for displaying comments in a list or for generating an RSS feed of comments.
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
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 );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.4.0 | Added the ability for $comment_ID to also accept a WP_Comment object. |
| 1.2.0 | Introduced. |