wp_xmlrpc_server::wp_deleteComment( array $args ): bool|IXR_Error
- Since
- 2.7.0
- Source
wp-includes/class-wp-xmlrpc-server.php:3732
Description
By default, the comment will be moved to the Trash instead of deleted.
See wp_delete_comment() for more information on this behavior.
Compatibility
- WordPress
- since 2.7.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.
Parameters
$argsarray- Method arguments. Note: arguments must be ordered as documented.
$0intBlog ID (unused).$1stringUsername.$2stringPassword.$3intComment ID.
Return value
bool|IXR_Error- See wp_delete_comment().
Performance profile
How much work a call to wp_xmlrpc_server::wp_deleteComment() 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
- Scaling
- Constant
- Instructions
- 16–41
- Plugin surface
- 2 hooks
- Called by
- 0
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 59.
Third-party callbacks on 'xmlrpc_call', 'xmlrpc_call_success_wp_deleteComment' run inside this call, and their cost is not bounded by anything here.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
do_action()called directly
Further down the call graph this can also reach cache, query, 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 · 5 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_xmlrpc_server::wp_deleteComment() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 16 | ->escape(), ->login() |
!get_comment() | 26 | ->escape(), ->login(), get_comment(), __() |
get_comment() && !current_user_can() | 31 | ->escape(), ->login(), get_comment(), current_user_can(), __() |
get_comment() && current_user_can() | 36 | ->escape(), ->login(), get_comment(), current_user_can(), do_action(), wp_delete_comment() |
get_comment() && current_user_can() | 41 | ->escape(), ->login(), get_comment(), current_user_can(), do_action(), wp_delete_comment(), do_action() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 59 instructions, 16–41 executed per call, 4 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.
Hooks and filters fired · 2
2 hooks fire while wp_xmlrpc_server::wp_deleteComment() runs, in this order:
- do_action( xmlrpc_call )actionline 3753 (+21 into the body)
Fires after the XML-RPC user has been authenticated but before the rest of the method logic begins.
- do_action( xmlrpc_call_success_wp_deleteComment )actionline 3766 (+34 into the body)
Fires after a comment has been successfully deleted via XML-RPC.
Uses · 8
- 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.
- wp_delete_comment()Trashes or deletes a comment.
- 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
public function wp_deleteComment( $args ) { $this->escape( $args ); $username = $args[1]; $password = $args[2]; $comment_id = (int) $args[3]; $user = $this->login( $username, $password ); if ( ! $user ) { return $this->error; } if ( ! get_comment( $comment_id ) ) { return new IXR_Error( 404, __( 'Invalid comment ID.' ) ); } if ( ! current_user_can( 'edit_comment', $comment_id ) ) { return new IXR_Error( 403, __( 'Sorry, you are not allowed to delete this comment.' ) ); } /** This action is documented in wp-includes/class-wp-xmlrpc-server.php */ do_action( 'xmlrpc_call', 'wp.deleteComment', $args, $this ); $status = wp_delete_comment( $comment_id ); if ( $status ) { /** * Fires after a comment has been successfully deleted via XML-RPC. * * @since 3.4.0 * * @param int $comment_id ID of the deleted comment. * @param array $args An array of arguments to delete the comment. */ do_action( 'xmlrpc_call_success_wp_deleteComment', $comment_id, $args ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.NotLowercase } return $status; }Changelog
Introduced in 2.7.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 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.