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.


git-svn-id: https://develop.svn.wordpress.org/trunk@34645 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-09-27 22:22:32 +00:00
parent c64bab4531
commit ed0ef8e2c0
1 changed files with 7 additions and 1 deletions

View File

@ -18,7 +18,13 @@
* as the second parameter. The hook for {@see 'plugins_api_args'} must ensure that
* 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:
*