get_comment_excerpt() WordPress Function

The get_comment_excerpt() function enables you to retrieve an excerpt for a comment. This is useful if you want to display a short summary of a comment on a list of comments, for example. The function takes a comment object as its only parameter.

get_comment_excerpt( int|WP_Comment $comment_ID ) #

Retrieves the excerpt of the given comment.


Description

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


Top ↑

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

(string) The possibly truncated comment excerpt.


Top ↑

Source

File: wp-includes/comment-template.php

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 );

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


Top ↑

Changelog

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

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More