W3cubDocs

/WordPress

wp_xmlrpc_server::wp_deleteComment( array $args )

Delete a comment.

Description

By default, the comment will be moved to the Trash instead of deleted. See wp_delete_comment() for more information on this behavior.

Parameters

$args

(array) (Required) Method arguments. Note: arguments must be ordered as documented.

'blog_id'
(int) (unused)
'username'
(string)
'password'
(string)
'comment_ID'
(int)

Return

(bool|IXR_Error) See wp_delete_comment().

Source

File: wp-includes/class-wp-xmlrpc-server.php

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' );

		$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;
	}

Uses

Uses	Description
wp-includes/capabilities.php: current_user_can()	Returns whether the current user has the specified capability.
wp-includes/l10n.php: __()	Retrieve the translation of $text.
wp-includes/plugin.php: do_action()	Execute functions hooked on a specific action hook.
wp-includes/class-wp-xmlrpc-server.php: xmlrpc_call_success_wp_deleteComment	Fires after a comment has been successfully deleted via XML-RPC.
wp-includes/class-wp-xmlrpc-server.php: xmlrpc_call	Fires after the XML-RPC user has been authenticated but before the rest of the method logic begins.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::escape()	Escape string or array of strings for database.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::login()	Log user in.
wp-includes/comment.php: wp_delete_comment()	Trashes or deletes a comment.
wp-includes/comment.php: get_comment()	Retrieves comment data given a comment ID or comment object.

Changelog

Version	Description
2.7.0	Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_xmlrpc_server/wp_deletecomment