wp_xmlrpc_server::wp_deleteComment( array $args )

Delete a comment.


Description 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 Parameters

$args

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

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


Top ↑

Return Return

(bool|IXR_Error) See wp_delete_comment().


Top ↑

Source 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];

		if ( ! $user = $this->login( $username, $password ) ) {
			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 );
		}

		return $status;
	}

Top ↑

Changelog Changelog

Changelog
Version Description
2.7.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

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