Changeset 34763 for trunk/src/wp-admin/includes/plugin-install.php

Timestamp:

10/02/2015 04:47:14 AM (9 years ago)

Author:

DrewAPicture

Message:

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.

File:

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

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

@@ -20 +20 @@
  *
  * 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.
  *