wp_xmlrpc_server::wp_deleteComment( array $args ): bool|IXR_Error

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.


Top ↑

Parameters

$args array Required
Method arguments. Note: arguments must be ordered as documented.
  • blog_idint
    (unused)
  • usernamestring
  • passwordstring
  • comment_IDint

Top ↑

Return

bool|IXR_Error See wp_delete_comment() .


Top ↑

Source

File: wp-includes/class-wp-xmlrpc-server.php. View all references

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

Top ↑

Hooks



Top ↑

Changelog

Changelog
Version Description
2.7.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.