WordPress.org

Make WordPress Core

Changeset 34645


Ignore:
Timestamp:
09/27/2015 10:22:32 PM (4 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/plugin-install.php

    r34642 r34645  
    1919 * an object is returned.
    2020 *
    21  * The second filter, {@see 'plugins_api'}, is the result that would be returned.
     21 * The second filter, {@see 'plugins_api'}, allows a plugin to override the WordPress.org
     22 * Plugin Install API entirely. If `$action` is 'query_plugins', 'plugin_information', or
     23 * 'hot_categories', an object MUST be passed. If `$action` is 'hot_tags`, an array should
     24 * be passed.
     25 *
     26 * Finally, the third filter, {@see 'plugins_api_result'}, makes it possible to filter the
     27 * response object or array, depending on the `$action` type.
    2228 *
    2329 * Supported arguments per action:
Note: See TracChangeset for help on using the changeset viewer.