Retrieves the excerpt of the given comment.
Description
Returns a maximum of 20 words with an ellipsis appended if necessary.
Parameters
$comment_idint|WP_Commentoptional- WP_Comment or ID of the comment for which to get the excerpt.
Default current comment.
Source
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 ); } Hooks
- apply_filters( ‘comment_excerpt_length’,
int $comment_excerpt_length ) Filters the maximum number of words used in the comment excerpt.
- apply_filters( ‘get_comment_excerpt’,
string $comment_excerpt ,string $comment_id ,WP_Comment $comment ) Filters the retrieved comment excerpt.
Changelog
| Version | Description |
|---|---|
| 4.4.0 | Added the ability for $comment_id to also accept a WP_Comment object. |
| 1.5.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.