From 4c6d50413b2c0b29e5fc9c6e869b6929fc1aa5f6 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Fri, 2 Oct 2015 04:47:14 +0000 Subject: [PATCH] Docs: Clarify the expected replacement element type if replacing the object or array in `plugins_api()` via the `plugins_api` hook. If the `$action` type is 'query_plugins' or 'plugin_information', the API will return an object, thus an object should be passed if replacing it. For 'hot_tags' and 'hot_categories', the same logic applies, but with arrays instead. See #34035. git-svn-id: https://develop.svn.wordpress.org/trunk@34763 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/plugin-install.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/wp-admin/includes/plugin-install.php b/src/wp-admin/includes/plugin-install.php index 77d145a5f6..9446637482 100644 --- a/src/wp-admin/includes/plugin-install.php +++ b/src/wp-admin/includes/plugin-install.php @@ -19,8 +19,8 @@ * an object is 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 + * Plugin Install API entirely. If `$action` is 'query_plugins' or 'plugin_information', + * an object MUST be passed. If `$action` is 'hot_tags` or 'hot_categories', an array MUST * be passed. * * Finally, the third filter, {@see 'plugins_api_result'}, makes it possible to filter the