get_comment_to_edit( int $id ): WP_Comment|false

Compatibility

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

Parameters

$idint

ID of comment to retrieve.

Return value

WP_Comment|false

Comment if found. False on failure.

Performance profile

How much work a call to get_comment_to_edit() 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

7–58

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

Plugin surface

1 hook

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

Called by

0

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

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach option, cache, serialize, query 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 · 2 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( comment_edit_pre )filterline 127 (+17 into the body)

   Filters the comment content before editing.

Uses · 4

• get_comment()Retrieves comment data given a comment ID or comment object.
• format_to_edit()Acts on text which is about to be edited.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• esc_url()Checks and cleans a URL.

Source code

View on Trac ↗View on GitHub ↗

110function get_comment_to_edit( $id ) {111	$comment = get_comment( $id );112	if ( ! $comment ) {113		return false;114	}115 116	$comment->comment_ID      = (int) $comment->comment_ID;117	$comment->comment_post_ID = (int) $comment->comment_post_ID;118 119	$comment->comment_content = format_to_edit( $comment->comment_content );120	/**121	 * Filters the comment content before editing.122	 *123	 * @since 2.0.0124	 *125	 * @param string $comment_content Comment content.126	 */127	$comment->comment_content = apply_filters( 'comment_edit_pre', $comment->comment_content );128 129	$comment->comment_author       = format_to_edit( $comment->comment_author );130	$comment->comment_author_email = format_to_edit( $comment->comment_author_email );131	$comment->comment_author_url   = format_to_edit( $comment->comment_author_url );132	$comment->comment_author_url   = esc_url( $comment->comment_author_url );133 134	return $comment;135}

Changelog

Introduced in 2.0.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 6.8.8 tag, from src/wp-admin/includes/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.