wp_xmlrpc_server::wp_deletePost()publicWP 3.4.0

Deletes a post for any registered post type.

Method of the class: wp_xmlrpc_server{}

Hooks from the method

Return

true|IXR_Error. True on success, IXR_Error instance on failure.

Usage

$wp_xmlrpc_server = new wp_xmlrpc_server();
$wp_xmlrpc_server->wp_deletePost( $args );
$args(array) (required)

Method arguments. Note: arguments must be ordered as documented.

  • 0(int)
    Blog ID (unused).

  • 1(string)
    Username.

  • 2(string)
    Password.

  • 3(int)
    Post ID.

Notes

Changelog

Since 3.4.0 Introduced.

wp_xmlrpc_server::wp_deletePost() code WP 6.5.2

public function wp_deletePost( $args ) {
	if ( ! $this->minimum_args( $args, 4 ) ) {
		return $this->error;
	}

	$this->escape( $args );

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

	$user = $this->login( $username, $password );
	if ( ! $user ) {
		return $this->error;
	}

	/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
	do_action( 'xmlrpc_call', 'wp.deletePost', $args, $this );

	$post = get_post( $post_id, ARRAY_A );
	if ( empty( $post['ID'] ) ) {
		return new IXR_Error( 404, __( 'Invalid post ID.' ) );
	}

	if ( ! current_user_can( 'delete_post', $post_id ) ) {
		return new IXR_Error( 401, __( 'Sorry, you are not allowed to delete this post.' ) );
	}

	$result = wp_delete_post( $post_id );

	if ( ! $result ) {
		return new IXR_Error( 500, __( 'Sorry, the post could not be deleted.' ) );
	}

	return true;
}