wppaste
WordPress

Walker_Comment::filter_comment_text( string $comment_text, WP_Comment|null $comment ): string

Since
5.4.2
Source
wp-includes/class-walker-comment.php:277
Filters the comment text.

Description

Removes links from the pending comment's text if the commenter did not consent to the comment cookies.

Compatibility

WordPress
since 5.4.2
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$comment_textstring
Text of the current comment.
$commentWP_Comment|null
The comment object. Null if not found.

Return value

string
Filtered text of the current comment.

Performance profile

How much work a call to Walker_Comment::filter_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
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

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

Instructions
9–18

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • hookthird-party callbacksapply_filters()one call below Walker_Comment::filter_comment_text()

What one call costs · 2 distinct outcomes

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

WhenInstructionsCalls it makes
always9–13wp_get_current_commenter()
$value18wp_get_current_commenter(), wp_kses()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 18 instructions, 9–18 executed per call, 3 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 2

Source code

View on Trac View on GitHub 

	public function filter_comment_text( $comment_text, $comment ) {		$commenter          = wp_get_current_commenter();		$show_pending_links = ! empty( $commenter['comment_author'] ); 		if ( $comment && '0' === $comment->comment_approved && ! $show_pending_links ) {			$comment_text = wp_kses( $comment_text, array() );		} 		return $comment_text;	}

Changelog

Introduced in 5.4.2. 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.1.0 tag, from src/wp-includes/class-walker-comment.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.