Changeset 32584

Timestamp:

05/24/2015 08:14:49 PM (10 years ago)

Author:

DrewAPicture

Message:

Add missing argument descriptions for the $args parameter in wp_xmlrpc_server->wp_getTaxonomy().

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

@@ -2070 +2070 @@
      *     @type int    $blog_id  Blog ID (unused).
      *     @type string $username Username.
-     *     @type string $password Password
+     *     @type string $password Password.
      *     @type string $taxnomy  Taxonomy name.
      *     @type array  $filter   Optional. Modifies the query used to retrieve posts. Accepts 'number',
@@ -2144 +2144 @@
      * @since 3.4.0
      *
-     * @uses get_taxonomy()
+     * @see get_taxonomy()
      *
      * @param array  $args {
      *     Method arguments. Note: arguments must be ordered as documented.
      *
-     *     @type int    $blog_id (unused)
-     *     @type string $username
-     *     @type string $password
-     *     @type string $taxnomy
-     *     @type array  $fields (optional)
-     * }
-     * @return array|IXR_Error (@see get_taxonomy())
+     *     @type int    $blog_id  Blog ID (unused).
+     *     @type string $username Username.
+     *     @type string $password Password.
+     *     @type string $taxnomy  Taxonomy name.
+     *     @type array  $fields   Optional. Array of taxonomy fields to limit to in the return.
+     *                            Accepts 'labels', 'cap', 'menu', and 'object_type'.
+     *                            Default empty array.
+     * }
+     * @return array|IXR_Error An array of taxonomy data on success, IXR_Error instance otherwise.
      */
     public function wp_getTaxonomy( $args ) {