Changeset 32576

Timestamp:

05/24/2015 04:55:38 PM (10 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:

• trunk/src/wp-includes/class-wp-xmlrpc-server.php (modified) (2 diffs)

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

@@ -1720 +1720 @@
             return array();
 
-        // holds all the posts data
+        // Holds all the posts data.
         $struct = array();
 
@@ -1738 +1738 @@
      * @since 3.4.0
      *
-     * @uses wp_insert_term()
-     * @param array $args Method parameters. Contains:
-     *  - int     $blog_id (unused)
-     *  - string  $username
-     *  - string  $password
-     *  - array   $content_struct
-     *      The $content_struct must contain:
-     *      - 'name'
-     *      - 'taxonomy'
-     *      Also, it can optionally contain:
-     *      - 'parent'
-     *      - 'description'
-     *      - 'slug'
-     * @return string|IXR_Error term_id
+     * @see wp_insert_term()
+     *
+     * @param array $args {
+     *     Method parameters.
+     *
+     *     @type int    $blog_id        Blog ID (unused).
+     *     @type string $username       Username.
+     *     @type string $password       Password.
+     *     @type array  $content_struct Content struct for adding a new term. The struct must contain
+     *                                  The term 'name' and 'taxonomy'. Optional accepted values include
+     *                                  'parent', 'description', and 'slug'.
+     * }
+     * @return int|IXR_Error The term ID on success, or an IXR_Error object on failure.
      */
     public function wp_newTerm( $args ) {