From ed0ef8e2c035039cdb8ec74f3f3e8f0486ee8c89 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sun, 27 Sep 2015 22:22:32 +0000 Subject: [PATCH] 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 --- src/wp-admin/includes/plugin-install.php | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/wp-admin/includes/plugin-install.php b/src/wp-admin/includes/plugin-install.php index aeea238c69..f4adbe4fdf 100644 --- a/src/wp-admin/includes/plugin-install.php +++ b/src/wp-admin/includes/plugin-install.php @@ -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: *