plugins_api( string $action, array|object $args = array() )
Retrieves plugin installer pages from the WordPress.org Plugins API.
Description Description
It is possible for a plugin to override the Plugin API result with three filters. Assume this is for plugins, which can extend on the Plugin Info to offer more choices. This is very powerful and must be used with care when overriding the filters.
The first filter, ‘plugins_api_args’, is for the args and gives the action as the second parameter. The hook for ‘plugins_api_args’ must ensure that an object is returned.
The second filter, ‘plugins_api’, allows a plugin to override the WordPress.org Plugin Installation 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, ‘plugins_api_result’, makes it possible to filter the response object or array, depending on the $action type.
Supported arguments per action:
| Argument Name | query_plugins | plugin_information | hot_tags | hot_categories |
|---|---|---|---|---|
$slug |
No | Yes | No | No |
$per_page |
Yes | No | No | No |
$page |
Yes | No | No | No |
$number |
No | No | Yes | Yes |
$search |
Yes | No | No | No |
$tag |
Yes | No | No | No |
$author |
Yes | No | No | No |
$user |
Yes | No | No | No |
$browse |
Yes | No | No | No |
$locale |
Yes | Yes | No | No |
$installed_plugins |
Yes | No | No | No |
$is_ssl |
Yes | Yes | No | No |
$fields |
Yes | Yes | No | No |
Parameters Parameters
- $action
-
(string) (Required) API action to perform: 'query_plugins', 'plugin_information', 'hot_tags' or 'hot_categories'.
- $args
-
(array|object) (Optional) Array or object of arguments to serialize for the Plugin Info API.
- 'slug'
(string) The plugin slug. - 'per_page'
(int) Number of plugins per page. Default 24. - 'page'
(int) Number of current page. Default 1. - 'number'
(int) Number of tags or categories to be queried. - 'search'
(string) A search term. - 'tag'
(string) Tag to filter plugins. - 'author'
(string) Username of an plugin author to filter plugins. - 'user'
(string) Username to query for their favorites. - 'browse'
(string) Browse view: 'popular', 'new', 'beta', 'recommended'. - 'locale'
(string) Locale to provide context-sensitive results. Default is the value of get_locale(). - 'installed_plugins'
(string) Installed plugins to provide context-sensitive results. - 'is_ssl'
(bool) Whether links should be returned with https or not. Default false. - 'fields'
(array) Array of fields which should or should not be returned.- 'short_description'
(bool) Whether to return the plugin short description. Default true. - 'description'
(bool) Whether to return the plugin full description. Default false. - 'sections'
(bool) Whether to return the plugin readme sections: description, installation, FAQ, screenshots, other notes, and changelog. Default false. - 'tested'
(bool) Whether to return the 'Compatible up to' value. Default true. - 'requires'
(bool) Whether to return the required WordPress version. Default true. - 'rating'
(bool) Whether to return the rating in percent and total number of ratings. Default true. - 'ratings'
(bool) Whether to return the number of rating for each star (1-5). Default true. - 'downloaded'
(bool) Whether to return the download count. Default true. - 'downloadlink'
(bool) Whether to return the download link for the package. Default true. - 'last_updated'
(bool) Whether to return the date of the last update. Default true. - 'added'
(bool) Whether to return the date when the plugin was added to the wordpress.org repository. Default true. - 'tags'
(bool) Whether to return the assigned tags. Default true. - 'compatibility'
(bool) Whether to return the WordPress compatibility list. Default true. - 'homepage'
(bool) Whether to return the plugin homepage link. Default true. - 'versions'
(bool) Whether to return the list of all available versions. Default false. - 'donate_link'
(bool) Whether to return the donation link. Default true. - 'reviews'
(bool) Whether to return the plugin reviews. Default false. - 'banners'
(bool) Whether to return the banner images links. Default false. - 'icons'
(bool) Whether to return the icon links. Default false. - 'active_installs'
(bool) Whether to return the number of active installations. Default false. - 'group'
(bool) Whether to return the assigned group. Default false. - 'contributors'
(bool) Whether to return the list of contributors. Default false.
- 'short_description'
Default value: array()
- 'slug'
Return Return
(object|array|WP_Error) Response object or array on success, WP_Error on failure. See the function reference article for more information on the make-up of possible return values depending on the value of $action.
Source Source
File: wp-admin/includes/plugin-install.php
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | function plugins_api( $action, $args = array() ) { // include an unmodified $wp_version include( ABSPATH . WPINC . '/version.php' ); if ( is_array( $args ) ) { $args = (object) $args; } if ( 'query_plugins' == $action ) { if ( ! isset( $args->per_page ) ) { $args->per_page = 24; } } if ( ! isset( $args->locale ) ) { $args->locale = get_user_locale(); } if ( ! isset( $args->wp_version ) ) { $args->wp_version = substr( $wp_version, 0, 3 ); // X.y } /** * Filters the WordPress.org Plugin Installation API arguments. * * Important: An object MUST be returned to this filter. * * @since 2.7.0 * * @param object $args Plugin API arguments. * @param string $action The type of information being requested from the Plugin Installation API. */ $args = apply_filters( 'plugins_api_args', $args, $action ); /** * Filters the response for the current WordPress.org Plugin Installation API request. * * Passing 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. * * @since 2.7.0 * * @param false|object|array $result The result object or array. Default false. * @param string $action The type of information being requested from the Plugin Installation API. * @param object $args Plugin API arguments. */ $res = apply_filters( 'plugins_api', false, $action, $args ); if ( false === $res ) { $url = add_query_arg( array( 'action' => $action, 'request' => $args, ), $url ); $http_url = $url; if ( $ssl = wp_http_supports( array( 'ssl' ) ) ) { $url = set_url_scheme( $url, 'https' ); } $http_args = array( 'timeout' => 15, 'user-agent' => 'WordPress/' . $wp_version . '; ' . home_url( '/' ), ); $request = wp_remote_get( $url, $http_args ); if ( $ssl && is_wp_error( $request ) ) { trigger_error( sprintf( /* translators: %s: support forums URL */ __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server’s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ), ) . ' ' . __( '(WordPress could not establish a secure connection to WordPress.org. Please contact your server administrator.)' ), headers_sent() || WP_DEBUG ? E_USER_WARNING : E_USER_NOTICE ); $request = wp_remote_get( $http_url, $http_args ); } if ( is_wp_error( $request ) ) { $res = new WP_Error( 'plugins_api_failed', sprintf( /* translators: %s: support forums URL */ __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server’s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ), ), $request->get_error_message() ); } else { $res = json_decode( wp_remote_retrieve_body( $request ), true ); if ( is_array( $res ) ) { // Object casting is required in order to match the info/1.0 format. $res = (object) $res; } elseif ( null === $res ) { $res = new WP_Error( 'plugins_api_failed', sprintf( /* translators: %s: support forums URL */ __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server’s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ), ), wp_remote_retrieve_body( $request ) ); } if ( isset( $res->error ) ) { $res = new WP_Error( 'plugins_api_failed', $res->error ); } } } elseif ( ! is_wp_error( $res ) ) { $res->external = true; } /** * Filters the Plugin Installation API response results. * * @since 2.7.0 * * @param object|WP_Error $res Response object or WP_Error. * @param string $action The type of information being requested from the Plugin Installation API. * @param object $args Plugin API arguments. */ return apply_filters( 'plugins_api_result', $res, $action, $args );} |
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 2.7.0 | Introduced. |