wp_xmlrpc_server::blogger_deletePost( array $args ): true|IXR_Error

Deletes a post.

Parameters

$argsarrayrequired
Method arguments. Note: arguments must be ordered as documented.
  • int
    Blog ID (unused).
  • 1 int
    Post ID.
  • 2 string
    Username.
  • 3 string
    Password.

Return

true|IXR_Error True when post is deleted.

Source

public function blogger_deletePost( $args ) {
	$this->escape( $args );

	$post_id  = (int) $args[1];
	$username = $args[2];
	$password = $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', 'blogger.deletePost', $args, $this );

	$actual_post = get_post( $post_id, ARRAY_A );

	if ( ! $actual_post || 'post' !== $actual_post['post_type'] ) {
		return new IXR_Error( 404, __( 'Sorry, no such post.' ) );
	}

	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.' ) );
	}

	/**
	 * Fires after a post has been successfully deleted via the XML-RPC Blogger API.
	 *
	 * @since 3.4.0
	 *
	 * @param int   $post_id ID of the deleted post.
	 * @param array $args    An array of arguments to delete the post.
	 */
	do_action( 'xmlrpc_call_success_blogger_deletePost', $post_id, $args ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.NotLowercase

	return true;
}

Hooks

do_action( ‘xmlrpc_call’, string $name, array|string $args, wp_xmlrpc_server $server )

Fires after the XML-RPC user has been authenticated but before the rest of the method logic begins.

do_action( ‘xmlrpc_call_success_blogger_deletePost’, int $post_id, array $args )

Fires after a post has been successfully deleted via the XML-RPC Blogger API.

Changelog

VersionDescription
1.5.0Introduced.

User Contributed Notes

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