WordPress.org

Make WordPress Core

Changeset 32576


Ignore:
Timestamp:
05/24/2015 04:55:38 PM (4 years ago)
Author:
DrewAPicture
Message:

Convert the $args parameter documentation in wp_xmlrpc_server->wp_newTerm() into 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

    r32575 r32576  
    17201720            return array();
    17211721
    1722         // holds all the posts data
     1722        // Holds all the posts data.
    17231723        $struct = array();
    17241724
     
    17381738     * @since 3.4.0
    17391739     *
    1740      * @uses wp_insert_term()
    1741      * @param array $args Method parameters. Contains:
    1742      *  - int     $blog_id (unused)
    1743      *  - string  $username
    1744      *  - string  $password
    1745      *  - array   $content_struct
    1746      *      The $content_struct must contain:
    1747      *      - 'name'
    1748      *      - 'taxonomy'
    1749      *      Also, it can optionally contain:
    1750      *      - 'parent'
    1751      *      - 'description'
    1752      *      - 'slug'
    1753      * @return string|IXR_Error term_id
     1740     * @see wp_insert_term()
     1741     *
     1742     * @param array $args {
     1743     *     Method parameters.
     1744     *
     1745     *     @type int    $blog_id        Blog ID (unused).
     1746     *     @type string $username       Username.
     1747     *     @type string $password       Password.
     1748     *     @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
     1750     *                                  'parent', 'description', and 'slug'.
     1751     * }
     1752     * @return int|IXR_Error The term ID on success, or an IXR_Error object on failure.
    17541753     */
    17551754    public function wp_newTerm( $args ) {
Note: See TracChangeset for help on using the changeset viewer.