get_comment_text() WordPress Function

The get_comment_text() function allows you to get the text of a comment. This function can be used in conjunction with the get_comment() function.

get_comment_text( int|WP_Comment $comment_ID, array $args = array() ) #

Retrieves the text of the current comment.


Description

Top ↑

See also


Top ↑

Parameters

$comment_ID

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

$args

(array)(Optional) An array of arguments.

Default value: array()


Top ↑

Return

(string) The comment content.


Top ↑

Source

File: wp-includes/comment-template.php

function get_comment_text( $comment_ID = 0, $args = array() ) {
	$comment = get_comment( $comment_ID );

	$comment_content = $comment->comment_content;

	if ( is_comment_feed() && $comment->comment_parent ) {
		$parent = get_comment( $comment->comment_parent );
		if ( $parent ) {
			$parent_link = esc_url( get_comment_link( $parent ) );
			$name        = get_comment_author( $parent );

			$comment_content = sprintf(
				/* translators: %s: Comment link. */
				ent2ncr( __( 'In reply to %s.' ) ),
				'<a href="' . $parent_link . '">' . $name . '</a>'
			) . "\n\n" . $comment_content;
		}
	}

	/**
	 * Filters the text of a comment.
	 *
	 * @since 1.5.0
	 *
	 * @see Walker_Comment::comment()
	 *
	 * @param string     $comment_content Text of the comment.
	 * @param WP_Comment $comment         The comment object.
	 * @param array      $args            An array of arguments.
	 */
	return apply_filters( 'get_comment_text', $comment_content, $comment, $args );
}


Top ↑

Changelog

Changelog
VersionDescription
5.4.0Added 'In reply to %s.' prefix to child comments in comments feed.
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