wp_xmlrpc_server::wp_deletePost( array $args )

Deletes a post for any registered post type.


Description

See also


Parameters

$args

(Required) Method arguments. Note: arguments must be ordered as documented.<br>

  • (int) Blog ID (unused).<br>
  • '1'
    (string) Username.<br>
  • '2'
    (string) Password.<br>
  • '3'
    (int) Post ID.<br>


Return

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


Source

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

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

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

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

		$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, __( 'The post cannot be deleted.' ) );
		}

		return true;
	}


Changelog

Changelog
Version Description
3.4.0 Introduced.