edit_comment(): int|WP_Error

Compatibility

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_comments().

Scaling

Scales with input

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

Instructions

41–193

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

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

• optionoption read or writeget_option()called directly
• querycontent queryget_comments()called directly
• hookthird-party callbacksapply_filters()one call below edit_comment()
• cacheobject cachewp_cache_get()one call below edit_comment()
• serializeserialisationmaybe_unserialize()one call below edit_comment()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 12 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.

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

Uses · 9

• 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.
• get_comment()Retrieves comment data given a comment ID or comment object.
• get_option()Retrieves an option value based on an option name.
• wp_get_comment_status()Retrieves the status of a comment by comment ID.
• get_comments()Retrieves a list of comments.
• wp_update_comment()Updates an existing comment in the database.
• WP_Error::__construct()Initializes the error.

Used by · 1

• wp_ajax_edit_comment()Handles editing a comment via AJAX.

Source code

View on Trac ↗View on GitHub ↗

54function edit_comment() {55	if ( ! current_user_can( 'edit_comment', (int) $_POST['comment_ID'] ) ) {56		wp_die( __( 'Sorry, you are not allowed to edit comments on this post.' ) );57	}58 59	if ( isset( $_POST['newcomment_author'] ) ) {60		$_POST['comment_author'] = $_POST['newcomment_author'];61	}62	if ( isset( $_POST['newcomment_author_email'] ) ) {63		$_POST['comment_author_email'] = $_POST['newcomment_author_email'];64	}65	if ( isset( $_POST['newcomment_author_url'] ) ) {66		$_POST['comment_author_url'] = $_POST['newcomment_author_url'];67	}68	if ( isset( $_POST['comment_status'] ) ) {69		$_POST['comment_approved'] = $_POST['comment_status'];70	}71	if ( isset( $_POST['content'] ) ) {72		$_POST['comment_content'] = $_POST['content'];73	}74	if ( isset( $_POST['comment_ID'] ) ) {75		$_POST['comment_ID'] = (int) $_POST['comment_ID'];76	}77 78	if ( isset( $_POST['comment_parent'] ) ) {79		$comment_id     = (int) $_POST['comment_ID'];80		$comment_parent = (int) $_POST['comment_parent'];81 82		$_POST['comment_parent'] = $comment_parent;83 84		$comment = get_comment( $comment_id );85 86		if ( $comment && $comment_parent && $comment_parent !== (int) $comment->comment_parent ) {87			if ( ! get_option( 'thread_comments' ) ) {88				return new WP_Error( 'comment_parent_invalid', __( 'The comment parent cannot be changed because threaded comments are disabled.' ) );89			}90 91			if ( $comment_parent === $comment_id ) {92				return new WP_Error( 'comment_parent_invalid', __( 'A comment cannot be a reply to itself.' ) );93			}94 95			$parent              = get_comment( $comment_parent );96			$parent_status       = $parent ? wp_get_comment_status( $parent ) : false;97			$comment_status      = $_POST['comment_approved'] ?? $comment->comment_approved;98			$comment_is_approved = in_array( $comment_status, array( 1, '1', 'approve' ), true );99 100			// The parent must be a comment of the same type, on the same post, and publicly visible if the comment is approved.101			if (102				! $parent103				|| (int) $parent->comment_post_ID !== (int) $comment->comment_post_ID104				|| $parent->comment_type !== $comment->comment_type105				|| in_array( $parent_status, array( 'spam', 'trash' ), true )106				|| ( $comment_is_approved && 'approved' !== $parent_status )107			) {108				return new WP_Error( 'comment_parent_invalid', __( 'Invalid parent comment.' ) );109			}110 111			// Walk up the new parent's ancestors to prevent creating a threading loop.112			$ancestors    = array();113			$ancestor     = $parent;114			$parent_depth = 1;115 116			while ( $ancestor && $ancestor->comment_parent && ! isset( $ancestors[ $ancestor->comment_ID ] ) ) {117				if ( (int) $ancestor->comment_parent === $comment_id ) {118					return new WP_Error( 'comment_parent_invalid', __( 'A comment cannot be a reply to one of its own replies.' ) );119				}120 121				$ancestors[ $ancestor->comment_ID ] = true;122				++$parent_depth;123 124				$ancestor = get_comment( $ancestor->comment_parent );125			}126 127			$max_thread_depth = (int) get_option( 'thread_comments_depth' );128 129			if ( $max_thread_depth ) {130				/*131				 * The comment's replies move with it, so the whole subtree must stay within132				 * the maximum depth. Measure its height one level of replies at a time,133				 * stopping as soon as the subtree cannot fit, which also bounds the loop

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 7.1.0 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.