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
This commit is contained in:
Drew Jaynes 2015-05-24 16:50:53 +00:00
parent 6548f58224
commit e117da47eb

View File

@ -1639,23 +1639,21 @@ class wp_xmlrpc_server extends IXR_Server {
* *
* @since 3.4.0 * @since 3.4.0
* *
* The optional $filter parameter modifies the query used to retrieve posts. * @see wp_get_recent_posts()
* Accepted keys are 'post_type', 'post_status', 'number', 'offset', * @see wp_getPost() for more on `$fields`
* 'orderby', and 'order'. * @see get_posts() for more on `$filter` values
* *
* The optional $fields parameter specifies what fields will be included * @param array $args {
* in the response array. * Method parameters.
* *
* @uses wp_get_recent_posts() * @type int $blog_id Blog ID (unused).
* @see wp_getPost() for more on $fields * @type string $username Username.
* @see get_posts() for more on $filter values * @type string $password Password.
* * @type array $filter Optional. Modifies the query used to retrieve posts. Accepts 'post_type',
* @param array $args Method parameters. Contains: * 'post_status', 'number', 'offset', 'orderby', and 'order'.
* - int $blog_id (unused) * Default empty array.
* - string $username * @type array $fields Optional. The subset of post type fields to return in the response array.
* - string $password * }
* - array $filter optional
* - array $fields optional
* @return array|IXR_Error Array contains a collection of posts. * @return array|IXR_Error Array contains a collection of posts.
*/ */
public function wp_getPosts( $args ) { public function wp_getPosts( $args ) {