From 4b7db6169816a12ef1002ce76019e5dd81ede1a7 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sun, 24 May 2015 20:10:27 +0000 Subject: [PATCH] Add missing argument descriptions for the `$args` parameter in `wp_xmlrpc_server->wp_getTerms()`. Also clarifies the return description. See #32246. git-svn-id: https://develop.svn.wordpress.org/trunk@32583 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class-wp-xmlrpc-server.php | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/src/wp-includes/class-wp-xmlrpc-server.php b/src/wp-includes/class-wp-xmlrpc-server.php index 94c5a4e59a..24c7525620 100644 --- a/src/wp-includes/class-wp-xmlrpc-server.php +++ b/src/wp-includes/class-wp-xmlrpc-server.php @@ -2062,18 +2062,19 @@ class wp_xmlrpc_server extends IXR_Server { * The optional $filter parameter modifies the query used to retrieve terms. * Accepted keys are 'number', 'offset', 'orderby', 'order', 'hide_empty', and 'search'. * - * @uses get_terms() + * @see get_terms() * * @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 $filter (optional) + * @type int $blog_id Blog ID (unused). + * @type string $username Username. + * @type string $password Password + * @type string $taxnomy Taxonomy name. + * @type array $filter Optional. Modifies the query used to retrieve posts. Accepts 'number', + * 'offset', 'orderby', 'order', 'hide_empty', and 'search'. Default empty array. * } - * @return array|IXR_Error terms + * @return array|IXR_Error An associative array of terms data on success, IXR_Error instance otherwise. */ public function wp_getTerms( $args ) { if ( ! $this->minimum_args( $args, 4 ) )