wp_xmlrpc_server::wp_deletePost( array $args )
Delete a post for any registered post type.
Description
See also
Parameters
- $args
-
(array) (Required) Method arguments. Note: arguments must be ordered as documented.
-
'blog_id'
(int) Blog ID (unused). -
'username'
(string) Username. -
'password'
(string) Password. -
'post_id'
(int) Post ID.
-
'blog_id'
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];
$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;
} Changelog
| Version | Description |
|---|---|
| 3.4.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_xmlrpc_server/wp_deletepost