Changeset 32585

Timestamp:

05/24/2015 08:32:09 PM (10 years ago)

Author:

DrewAPicture

Message:

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

Also documents missing $filter and $fields arguments and associated descriptions, and clarifies the return description.

See #32246.

File:

• trunk/src/wp-includes/class-wp-xmlrpc-server.php (modified) (1 diff)

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

@@ -2205 +2205 @@
      * @since 3.4.0
      *
-     * @uses get_taxonomies()
+     * @see get_taxonomies()
      *
      * @param array  $args {
      *     Method arguments. Note: arguments must be ordered as documented.
      *
-     *     @type int    $blog_id (unused)
-     *     @type string $username
-     *     @type string $password
-     * }
-     * @return array taxonomies
+     *     @type int    $blog_id  Blog ID (unused).
+     *     @type string $username Username.
+     *     @type string $password Password.
+     *     @type array  $filter   Optional. An array of arguments for retrieving taxonomies.
+     *     @type array  $fields   Optional. The subset of taxonomy fields to return.
+     * }
+     * @return array|string An associative array of taxonomy data with returned fields determined
+     *                      by `$fields`, or an error on failure.
      */
     public function wp_getTaxonomies( $args ) {