From a52e959d8e9a5ea367b23b41249ea6b37dc6c943 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sun, 24 May 2015 16:40:23 +0000 Subject: [PATCH] Add missing argument descriptions in the DocBlock for `wp_xmlrpc_server->wp_deletePost()`. See #32246. git-svn-id: https://develop.svn.wordpress.org/trunk@32572 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class-wp-xmlrpc-server.php | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/src/wp-includes/class-wp-xmlrpc-server.php b/src/wp-includes/class-wp-xmlrpc-server.php index d73770d859..d90df87a94 100644 --- a/src/wp-includes/class-wp-xmlrpc-server.php +++ b/src/wp-includes/class-wp-xmlrpc-server.php @@ -1474,11 +1474,13 @@ class wp_xmlrpc_server extends IXR_Server { } } - // convert the date field back to IXR form + // Convert the date field back to IXR form. $post['post_date'] = $this->_convert_date( $post['post_date'] ); - // ignore the existing GMT date if it is empty or a non-GMT date was supplied in $content_struct, - // since _insert_post will ignore the non-GMT date if the GMT date is set + /* + * Ignore the existing GMT date if it is empty or a non-GMT date was supplied in $content_struct, + * since _insert_post() will ignore the non-GMT date if the GMT date is set. + */ if ( $post['post_date_gmt'] == '0000-00-00 00:00:00' || isset( $content_struct['post_date'] ) ) unset( $post['post_date_gmt'] ); else @@ -1499,17 +1501,17 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * @uses wp_delete_post() + * @see wp_delete_post() * * @param array $args { * Method parameters, in this order: * - * @type int $blog_id (unused) - * @type string $username - * @type string $password - * @type int $post_id + * @type int $blog_id Blog ID (unused). + * @type string $username Username. + * @type string $password Password. + * @type int $post_id Post ID. * } - * @return true|IXR_Error true on success + * @return true|IXR_Error True on success, IXR_Error instance on failure. */ public function wp_deletePost( $args ) { if ( ! $this->minimum_args( $args, 4 ) )