Changeset 34641

Timestamp:

09/27/2015 09:59:12 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Further improve documentation for plugins_api().

• Adds a matrix-like data table demonstrating which arguments are available for the different $action types
• Adjusts the return types to accommodate an array for the 'hot_tags' $action choice

Props ocean90.
See #34035.

File:

• trunk/src/wp-admin/includes/plugin-install.php (modified) (2 diffs)

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

@@ -20 +20 @@
  *
  * The second filter, {@see 'plugins_api'}, is the result that would be returned.
+ *
+ * Supported arguments per action:
+ *
+ * | Argument Name        | query_plugins | plugin_information | hot_tags | hot_categories |
+ * | -------------------- | :-----------: | :----------------: | :------: | :------------: |
+ * | `$slug`              | No            |  Yes               | No       | No             |
+ * | `$per_page`          | Yes           |  No                | No       | No             |
+ * | `$page`              | Yes           |  No                | No       | No             |
+ * | `$number`            | No            |  No                | Yes      | Yes            |
+ * | `$search`            | Yes           |  No                | No       | No             |
+ * | `$tag`               | Yes           |  No                | No       | No             |
+ * | `$author`            | Yes           |  No                | No       | No             |
+ * | `$user`              | Yes           |  No                | No       | No             |
+ * | `$browse`            | Yes           |  No                | No       | No             |
+ * | `$locale`            | Yes           |  Yes               | No       | No             |
+ * | `$installed_plugins` | Yes           |  No                | No       | No             |
+ * | `$is_ssl`            | Yes           |  Yes               | No       | No             |
+ * | `$fields`            | Yes           |  Yes               | No       | No             |
  *
  * @since 2.7.0
@@ -71 +89 @@
  *     }
  * }
- * @return object|WP_Error Response object on success, WP_Error on failure. See the
+ * @return object|array|WP_Error Response object or array on success, WP_Error on failure. See the
  *         {@link https://developer.wordpress.org/reference/functions/plugins_api/ function reference article}
- *         for more information on the make-up of possible return objects depending on the value of `$action`.
+ *         for more information on the make-up of possible return values depending on the value of `$action`.
  */
 function plugins_api( $action, $args = array() ) {