wp_xmlrpc_server::wp_editComment( array $args ): true|IXR_Error

Description

Compatibility

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

Parameters

$argsarray

Method arguments. Note: arguments must be ordered as documented.

• $0int

  Blog ID (unused).

• $1string

  Username.

• $2string

  Password.

• $3int

  Comment ID.

• $4array

  Content structure.

Return value

true|IXR_Error

True, on success.

Performance profile

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

Constant

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

Instructions

17–107

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

Plugin surface

2 hooks

Third-party callbacks on 'xmlrpc_call', 'xmlrpc_call_success_wp_editComment' 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 callbacksdo_action()called directly
• querycontent queryget_post()one call below wp_xmlrpc_server::wp_editComment()

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

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

Hooks and filters fired · 2

2 hooks fire while wp_xmlrpc_server::wp_editComment() runs, in this order:

1. 1
   do_action( xmlrpc_call )actionline 3832 (+22 into the body)

   Fires after the XML-RPC user has been authenticated but before the rest of the method logic begins.

2. 2
   do_action( xmlrpc_call_success_wp_editComment )actionline 3890 (+80 into the body)

   Fires after a comment has been successfully updated via XML-RPC.

Uses · 12

• get_comment()Retrieves comment data given a comment ID or comment object.
• __()Retrieves the translation of $text.
• current_user_can()Returns whether the current user has the specified capability.
• do_action()Calls the callback functions that have been added to an action hook.
• get_comment_statuses()Retrieves all of the WordPress supported comment statuses.
• get_date_from_gmt()Given a date in UTC or GMT timezone, returns that date in the timezone of the site.
• iso8601_to_datetime()Given an ISO 8601 (Ymd\TH:i:sO) date, returns a MySQL DateTime (Y-m-d H:i:s) format used by post_date[_gmt].
• wp_update_comment()Updates an existing comment in the database.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_xmlrpc_server::escape()Escapes string or array of strings for database.
• wp_xmlrpc_server::login()Logs user in.
• IXR_Error::__construct()PHP5 constructor.

Source code

View on Trac ↗View on GitHub ↗

3810	public function wp_editComment( $args ) {3811		$this->escape( $args );3812 3813		$username       = $args[1];3814		$password       = $args[2];3815		$comment_id     = (int) $args[3];3816		$content_struct = $args[4];3817 3818		$user = $this->login( $username, $password );3819		if ( ! $user ) {3820			return $this->error;3821		}3822 3823		if ( ! get_comment( $comment_id ) ) {3824			return new IXR_Error( 404, __( 'Invalid comment ID.' ) );3825		}3826 3827		if ( ! current_user_can( 'edit_comment', $comment_id ) ) {3828			return new IXR_Error( 403, __( 'Sorry, you are not allowed to moderate or edit this comment.' ) );3829		}3830 3831		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */3832		do_action( 'xmlrpc_call', 'wp.editComment', $args, $this );3833		$comment = array(3834			'comment_ID' => $comment_id,3835		);3836 3837		if ( isset( $content_struct['status'] ) ) {3838			$statuses = get_comment_statuses();3839			$statuses = array_keys( $statuses );3840 3841			if ( ! in_array( $content_struct['status'], $statuses, true ) ) {3842				return new IXR_Error( 401, __( 'Invalid comment status.' ) );3843			}3844 3845			$comment['comment_approved'] = $content_struct['status'];3846		}3847 3848		// Do some timestamp voodoo.3849		if ( ! empty( $content_struct['date_created_gmt'] ) ) {3850			// We know this is supposed to be GMT, so we're going to slap that Z on there by force.3851			$date_created = rtrim( $content_struct['date_created_gmt']->getIso(), 'Z' ) . 'Z';3852 3853			$comment['comment_date']     = get_date_from_gmt( $date_created );3854			$comment['comment_date_gmt'] = iso8601_to_datetime( $date_created, 'gmt' );3855		}3856 3857		if ( isset( $content_struct['content'] ) ) {3858			$comment['comment_content'] = $content_struct['content'];3859		}3860 3861		if ( isset( $content_struct['author'] ) ) {3862			$comment['comment_author'] = $content_struct['author'];3863		}3864 3865		if ( isset( $content_struct['author_url'] ) ) {3866			$comment['comment_author_url'] = $content_struct['author_url'];3867		}3868 3869		if ( isset( $content_struct['author_email'] ) ) {3870			$comment['comment_author_email'] = $content_struct['author_email'];3871		}3872 3873		$result = wp_update_comment( $comment, true );3874		if ( is_wp_error( $result ) ) {3875			return new IXR_Error( 500, $result->get_error_message() );3876		}3877 3878		if ( ! $result ) {3879			return new IXR_Error( 500, __( 'Sorry, the comment could not be updated.' ) );3880		}3881 3882		/**3883		 * Fires after a comment has been successfully updated via XML-RPC.3884		 *3885		 * @since 3.4.03886		 *3887		 * @param int   $comment_id ID of the updated comment.3888		 * @param array $args       An array of arguments to update the comment.3889		 */

Changelog

Introduced in 2.7.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-includes/class-wp-xmlrpc-server.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.