Changeset 34645

Timestamp:

09/27/2015 10:22:32 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Adjust the plugins_api() DocBlock description to clarify the "second" available hook, plugins_api, and add new information for the "third" hook, plugins_api_result.

See #34035.

File:

• trunk/src/wp-admin/includes/plugin-install.php (modified) (1 diff)

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

@@ -19 +19 @@
  * an object is returned.
  *
- * The second filter, {@see 'plugins_api'}, is the result that would be returned.
+ * The second filter, {@see 'plugins_api'}, allows a plugin to override the WordPress.org
+ * Plugin Install API entirely. If `$action` is 'query_plugins', 'plugin_information', or
+ * 'hot_categories', an object MUST be passed. If `$action` is 'hot_tags`, an array should
+ * be passed.
+ *
+ * Finally, the third filter, {@see 'plugins_api_result'}, makes it possible to filter the
+ * response object or array, depending on the `$action` type.
  *
  * Supported arguments per action: