Ticket #34035: 34035.patch

src/wp-admin/includes/plugin-install.php

@@ -22 +22 @@
  *
  * @since 2.7.0
  *
- * @param string $action
- * @param array|object $args Optional. Arguments to serialize for the Plugin Info API.
- * @return object plugins_api response object on success, WP_Error on failure.
+ * @param string       $action Action to perform: 'query_plugins', 'plugin_information',
+ *                             'hot_tags' or 'hot_categories'.
+ * @param array|object $args   {
+ *     Optional. Array or object of arguments to serialize for the Plugin Info API.
+ *
+ *     @type string  $slug     The slug of a plugin.
+ *     @type int     $per_page Number of plugins per page. Default 24.
+ *     @type int     $number   Number of tags or categories to be queried.
+ *     @type string  $locale   Locale to provide context-sensitive results. Default get_locale().
+ *     @type bool    $is_ssl   Whether  links should be returned with http or https. Default false.
+ *     @type array   $fields   {
+ *         Array of fields which should or should not be returned.
+ *
+ *         @type bool $short_description Default true.
+ *         @type bool $description       Default false.
+ *         @type bool $sections          Default true.
+ *         @type bool $tested            Default true.
+ *         @type bool $requires          Default true.
+ *         @type bool $rating            Default true.
+ *         @type bool $ratings           Default true.
+ *         @type bool $downloaded        Default true.
+ *         @type bool $downloadlink      Default true.
+ *         @type bool $last_updated      Default true.
+ *         @type bool $added             Default true.
+ *         @type bool $tags              Default true.
+ *         @type bool $compatibility     Default true.
+ *         @type bool $homepage          Default true.
+ *         @type bool $versions          Default false.
+ *         @type bool $donate_link       Default true.
+ *         @type bool $reviews           Default false.
+ *         @type bool $banners           Default false.
+ *         @type bool $icons             Default false.
+ *         @type bool $active_installs   Default false.
+ *         @type bool $group             Default false.
+ *         @type bool $contributors      Default false.
+ *     }
+ * }
+ * @return object|WP_Error Response object on success, WP_Error on failure.
  */
-function plugins_api($action, $args = null) {
+function plugins_api( $action, $args = null ) {
 
         if ( is_array( $args ) ) {
                 $args = (object) $args;