get_comment_excerpt( int|WP_Comment $comment_ID )

Retrieves the excerpt of the given comment.


Description Description

Returns a maximum of 20 words with an ellipsis appended if necessary.


Top ↑

Parameters Parameters

$comment_ID

(int|WP_Comment) (Required) WP_Comment or ID of the comment for which to get the excerpt. Default current comment.


Top ↑

Return Return

(string) The possibly truncated comment excerpt.


Top ↑

Source Source

File: wp-includes/comment-template.php

function get_comment_excerpt( $comment_ID = 0 ) {
	$comment      = get_comment( $comment_ID );
	$comment_text = strip_tags( str_replace( array( "\n", "\r" ), ' ', $comment->comment_content ) );

	/* translators: Maximum number of words used in a comment excerpt. */
	$comment_excerpt_length = intval( _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 );

	$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     $excerpt    The comment excerpt text.
	 * @param int        $comment_ID The comment ID.
	 * @param WP_Comment $comment    The comment object.
	 */
	return apply_filters( 'get_comment_excerpt', $excerpt, $comment->comment_ID, $comment );
}


Top ↑

Changelog Changelog

Changelog
Version Description
4.4.0 Added the ability for $comment_ID to also accept a WP_Comment object.
1.5.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.