wppaste
WordPress

edit_comment(): int|WP_Error

Since
2.0.0, 5.5.0
Source
wp-admin/includes/comment.php:53
Updates a comment with values provided in $_POST.

Compatibility

WordPress
since 5.5.0
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.

Return value

int|WP_Error
The value 1 if the comment was updated, 0 if not updated.
A WP_Error object on failure.

Performance profile

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

Reaches the database via get_post().

Scaling
Scales with input

The body loops, so the work grows with how much data it finds.

Instructions
38–130

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

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

What it touches

  • hookthird-party callbacksapply_filters()one call below edit_comment()
  • querycontent queryget_post()one call below edit_comment()

Further down the call graph this can also reach cache, serialize, option 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 edit_comment() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
current_user_can()38–130current_user_can(), wp_update_comment()
!current_user_can() && !isset($value)44–121current_user_can(), __(), wp_die(), wp_update_comment()

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev14038–13016
8.514038–13016
8.414038–13016
8.314038–13016
8.214038–13016
8.114038–130163 fewer instructions than PHP 7.4
7.414338–13316

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 · 4

  • current_user_can()Returns whether the current user has the specified capability.
  • wp_die()Kills WordPress execution and displays HTML page with an error message.
  • __()Retrieves the translation of $text.
  • wp_update_comment()Updates an existing comment in the database.

Used by · 1

Source code

View on Trac View on GitHub 

function edit_comment() {	if ( ! current_user_can( 'edit_comment', (int) $_POST['comment_ID'] ) ) {		wp_die( __( 'Sorry, you are not allowed to edit comments on this post.' ) );	} 	if ( isset( $_POST['newcomment_author'] ) ) {		$_POST['comment_author'] = $_POST['newcomment_author'];	}	if ( isset( $_POST['newcomment_author_email'] ) ) {		$_POST['comment_author_email'] = $_POST['newcomment_author_email'];	}	if ( isset( $_POST['newcomment_author_url'] ) ) {		$_POST['comment_author_url'] = $_POST['newcomment_author_url'];	}	if ( isset( $_POST['comment_status'] ) ) {		$_POST['comment_approved'] = $_POST['comment_status'];	}	if ( isset( $_POST['content'] ) ) {		$_POST['comment_content'] = $_POST['content'];	}	if ( isset( $_POST['comment_ID'] ) ) {		$_POST['comment_ID'] = (int) $_POST['comment_ID'];	} 	foreach ( array( 'aa', 'mm', 'jj', 'hh', 'mn' ) as $timeunit ) {		if ( ! empty( $_POST[ 'hidden_' . $timeunit ] ) && $_POST[ 'hidden_' . $timeunit ] !== $_POST[ $timeunit ] ) {			$_POST['edit_date'] = '1';			break;		}	} 	if ( ! empty( $_POST['edit_date'] ) ) {		$aa = $_POST['aa'];		$mm = $_POST['mm'];		$jj = $_POST['jj'];		$hh = $_POST['hh'];		$mn = $_POST['mn'];		$ss = $_POST['ss'];		$jj = ( $jj > 31 ) ? 31 : $jj;		$hh = ( $hh > 23 ) ? $hh - 24 : $hh;		$mn = ( $mn > 59 ) ? $mn - 60 : $mn;		$ss = ( $ss > 59 ) ? $ss - 60 : $ss; 		$_POST['comment_date'] = "$aa-$mm-$jj $hh:$mn:$ss";	} 	return wp_update_comment( $_POST, true );}

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.

5.5.0
A return value was added.from the docblock
2.0.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.9.7 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.