WordPress.org

Make WordPress Core

Changeset 32577


Ignore:
Timestamp:
05/24/2015 04:59:26 PM (5 years ago)
Author:
DrewAPicture
Message:

Convert the $args parameter documentation in wp_xmlrpc_server->wp_editTerm() to a hash notation.

Also clarifies the return description.

See #32246.

File:
1 edited

Legend:

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

    r32576 r32577  
    17471747     *     @type string $password       Password.
    17481748     *     @type array  $content_struct Content struct for adding a new term. The struct must contain
    1749      *                                  The term 'name' and 'taxonomy'. Optional accepted values include
     1749     *                                  the term 'name' and 'taxonomy'. Optional accepted values include
    17501750     *                                  'parent', 'description', and 'slug'.
    17511751     * }
     
    18231823     * @since 3.4.0
    18241824     *
    1825      * @uses wp_update_term()
    1826      * @param array $args Method parameters. Contains:
    1827      *  - int     $blog_id (unused)
    1828      *  - string  $username
    1829      *  - string  $password
    1830      *  - string  $term_id
    1831      *  - array   $content_struct
    1832      *      The $content_struct must contain:
    1833      *      - 'taxonomy'
    1834      *      Also, it can optionally contain:
    1835      *      - 'name'
    1836      *      - 'parent'
    1837      *      - 'description'
    1838      *      - 'slug'
    1839      * @return true|IXR_Error True, on success.
     1825     * @see wp_update_term()
     1826     *
     1827     * @param array $args {
     1828     *     Method parameters.
     1829     *
     1830     *     @type int    $blog_id        Blog ID (unused).
     1831     *     @type string $username       Username.
     1832     *     @type string $password       Password.
     1833     *     @type int    $term_id        Term ID.
     1834     *     @type array  $content_struct Content struct for editing a term. The struct must contain the
     1835     *                                  term ''taxonomy'. Optional accepted values include 'name', 'parent',
     1836     *                                  'description', and 'slug'.
     1837     * }
     1838     * @return true|IXR_Error True on success, IXR_Error instance on failure.
    18401839     */
    18411840    public function wp_editTerm( $args ) {
Note: See TracChangeset for help on using the changeset viewer.