Changeset 32572

Timestamp:

05/24/2015 04:40:23 PM (11 years ago)

Author:

DrewAPicture

Message:

Add missing argument descriptions in the DocBlock for wp_xmlrpc_server->wp_deletePost().

See #32246.

File:

• trunk/src/wp-includes/class-wp-xmlrpc-server.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-xmlrpc-server.php

@@ -1475 +1475 @@
                 }
 
-                // 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'] );
@@ -1500 +1502 @@
          * @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 ) {