plugins_api WordPress Filter Hook

The plugins_api hook is used for plugin API calls. It allows for plugins to be called from outside of WordPress. This hook is used by the plugin API to make sure that plugins are called correctly. It is also used by other parts of WordPress to make sure that plugins are called correctly.

apply_filters( 'plugins_api', false|object|array $result, string $action, object $args ) #

Filters the response for the current WordPress.org Plugin Installation API request.


Description

Returning a non-false value will effectively short-circuit the WordPress.org API request.

If $action is ‘query_plugins’ or ‘plugin_information’, an object MUST be passed. If $action is ‘hot_tags’ or ‘hot_categories’, an array should be passed.


Top ↑

Parameters

$result

(false|object|array)The result object or array. Default false.

$action

(string)The type of information being requested from the Plugin Installation API.

$args

(object)Plugin API arguments.


Top ↑

Source

File: wp-admin/includes/plugin-install.php

View on Trac



Top ↑

Changelog

Changelog
VersionDescription
2.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.