From e117da47eb577f2af7d279454a317fe1ba4964cc Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sun, 24 May 2015 16:50:53 +0000 Subject: [PATCH] Convert the `$args` parameter for `wp_xmlrpc_server->wp_getPosts()` into a hash notation. Also considates documentation to the argument descriptions themselves. See #32246. git-svn-id: https://develop.svn.wordpress.org/trunk@32575 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class-wp-xmlrpc-server.php | 28 ++++++++++------------ 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/src/wp-includes/class-wp-xmlrpc-server.php b/src/wp-includes/class-wp-xmlrpc-server.php index b2d8f83153..65eed8557a 100644 --- a/src/wp-includes/class-wp-xmlrpc-server.php +++ b/src/wp-includes/class-wp-xmlrpc-server.php @@ -1639,23 +1639,21 @@ class wp_xmlrpc_server extends IXR_Server { * * @since 3.4.0 * - * The optional $filter parameter modifies the query used to retrieve posts. - * Accepted keys are 'post_type', 'post_status', 'number', 'offset', - * 'orderby', and 'order'. + * @see wp_get_recent_posts() + * @see wp_getPost() for more on `$fields` + * @see get_posts() for more on `$filter` values * - * The optional $fields parameter specifies what fields will be included - * in the response array. + * @param array $args { + * Method parameters. * - * @uses wp_get_recent_posts() - * @see wp_getPost() for more on $fields - * @see get_posts() for more on $filter values - * - * @param array $args Method parameters. Contains: - * - int $blog_id (unused) - * - string $username - * - string $password - * - array $filter optional - * - array $fields optional + * @type int $blog_id Blog ID (unused). + * @type string $username Username. + * @type string $password Password. + * @type array $filter Optional. Modifies the query used to retrieve posts. Accepts 'post_type', + * 'post_status', 'number', 'offset', 'orderby', and 'order'. + * Default empty array. + * @type array $fields Optional. The subset of post type fields to return in the response array. + * } * @return array|IXR_Error Array contains a collection of posts. */ public function wp_getPosts( $args ) {