Changeset 32575

Timestamp:

05/24/2015 04:50:53 PM (9 years ago)

Author:

DrewAPicture

Message:

Convert the $args parameter for wp_xmlrpc_server->wp_getPosts() into a hash notation.

Also considates documentation to the argument descriptions themselves.

See #32246.

File:

• trunk/src/wp-includes/class-wp-xmlrpc-server.php (modified) (1 diff)

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

@@ -1640 +1640 @@
      * @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'.
-     *
-     * The optional $fields parameter specifies what fields will be included
-     * in the response array.
-     *
-     * @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
+     * @see wp_get_recent_posts()
+     * @see wp_getPost() for more on `$fields`
+     * @see get_posts() for more on `$filter` values
+     *
+     * @param array $args {
+     *     Method parameters.
+     *
+     *     @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.
      */