get_comment_text( int|WP_Comment $comment_id = 0, array $args = array() ): string

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$comment_idint|WP_Commentoptional

WP_Comment or ID of the comment for which to get the text.
Default current comment.Default: 0

$argsarrayoptional

An array of arguments. Default empty array.Default: array()

Return value

string

The comment content.

Performance profile

How much work a call to get_comment_text() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

17–54

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 54.

Plugin surface

1 hook

Third-party callbacks on 'get_comment_text' run inside this call, and their cost is not bounded by anything here.

Called by

5

5 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()one call below get_comment_text()

Further down the call graph this can also reach query, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 3 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_comment_text() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while get_comment_text() runs, in this order:

1. 1
   apply_filters( get_comment_text )filterline 1059 (+30 into the body)

   Filters the text of a comment.

Uses · 8

• get_comment()Retrieves comment data given a comment ID or comment object.
• is_comment_feed()Is the query for a comments feed?
• esc_url()Checks and cleans a URL.
• get_comment_link()Retrieves the link to a given comment.
• get_comment_author()Retrieves the author of the current comment.
• ent2ncr()Converts named entities into numbered entities.
• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 5

• comment_text()Displays the text of the current comment.
• comment_text_rss()Displays the current comment content for use in the feeds.
• render_block_core_comment_content()Renders the `core/comment-content` block on the server.
• render_block_core_latest_comments()Renders the `core/latest-comments` block on server.
• wp_comments_personal_data_exporter()Finds and exports personal data associated with an email address from the comments table.

Source code

View on Trac ↗View on GitHub ↗

1029function get_comment_text( $comment_id = 0, $args = array() ) {1030	$comment = get_comment( $comment_id );1031 1032	$comment_text = $comment->comment_content;1033 1034	if ( is_comment_feed() && $comment->comment_parent ) {1035		$parent = get_comment( $comment->comment_parent );1036		if ( $parent ) {1037			$parent_link = esc_url( get_comment_link( $parent ) );1038			$name        = get_comment_author( $parent );1039 1040			$comment_text = sprintf(1041				/* translators: %s: Comment link. */1042				ent2ncr( __( 'In reply to %s.' ) ),1043				'<a href="' . $parent_link . '">' . $name . '</a>'1044			) . "\n\n" . $comment_text;1045		}1046	}1047 1048	/**1049	 * Filters the text of a comment.1050	 *1051	 * @since 1.5.01052	 *1053	 * @see Walker_Comment::comment()1054	 *1055	 * @param string     $comment_text Text of the comment.1056	 * @param WP_Comment $comment      The comment object.1057	 * @param array      $args         An array of arguments.1058	 */1059	return apply_filters( 'get_comment_text', $comment_text, $comment, $args );1060}

Changelog

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/comment-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.