WordPress.org

Make WordPress Core

Changeset 32575


Ignore:
Timestamp:
05/24/2015 04:50:53 PM (4 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-xmlrpc-server.php

    r32574 r32575  
    16401640     * @since 3.4.0
    16411641     *
    1642      * The optional $filter parameter modifies the query used to retrieve posts.
    1643      * Accepted keys are 'post_type', 'post_status', 'number', 'offset',
    1644      * 'orderby', and 'order'.
    1645      *
    1646      * The optional $fields parameter specifies what fields will be included
    1647      * in the response array.
    1648      *
    1649      * @uses wp_get_recent_posts()
    1650      * @see wp_getPost() for more on $fields
    1651      * @see get_posts() for more on $filter values
    1652      *
    1653      * @param array $args Method parameters. Contains:
    1654      *  - int     $blog_id (unused)
    1655      *  - string  $username
    1656      *  - string  $password
    1657      *  - array   $filter optional
    1658      *  - array   $fields optional
     1642     * @see wp_get_recent_posts()
     1643     * @see wp_getPost() for more on `$fields`
     1644     * @see get_posts() for more on `$filter` values
     1645     *
     1646     * @param array $args {
     1647     *     Method parameters.
     1648     *
     1649     *     @type int    $blog_id  Blog ID (unused).
     1650     *     @type string $username Username.
     1651     *     @type string $password Password.
     1652     *     @type array  $filter   Optional. Modifies the query used to retrieve posts. Accepts 'post_type',
     1653     *                            'post_status', 'number', 'offset', 'orderby', and 'order'.
     1654     *                            Default empty array.
     1655     *     @type array  $fields   Optional. The subset of post type fields to return in the response array.
     1656     * }
    16591657     * @return array|IXR_Error Array contains a collection of posts.
    16601658     */
Note: See TracChangeset for help on using the changeset viewer.