wp_xmlrpc_server::wp_deleteComment() – Delete a comment.

You appear to be a bot. Output may be restricted

Description

Delete a comment.

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

Usage

$bool|IXR_Error = wp_xmlrpc_server::wp_deleteComment( $args );

Parameters

$args
( array ) required – { Method arguments. Note: arguments must be ordered as documented.
$0
( int ) required – Blog ID (unused).
$1
( string ) required – Username.
$2
( string ) required – Password.
$3
( int ) required – Comment ID. }

Returns

bool|IXR_Error See wp_delete_comment().

Source

File name: wordpress/wp-includes/class-wp-xmlrpc-server.php
Lines:

1 to 39 of 39
  public function wp_deleteComment( $args ) {
    $this->wp_xmlrpc_server::escape( $args );

    $username   = $args[1];
    $password   = $args[2];
    $comment_ID = (int) $args[3];

    $user = $this->wp_xmlrpc_server::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;
  }
 

 View on GitHub View on Trac