plugins_api( string $action, array|object $args = array() ): object|array|WP_Error

Retrieves plugin installer pages from the WordPress.org Plugins API.


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

Top ↑

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.
  • slugstring
    The plugin slug.
  • per_pageint
    Number of plugins per page. Default 24.
  • pageint
    Number of current page. Default 1.
  • numberint
    Number of tags or categories to be queried.
  • searchstring
    A search term.
  • tagstring
    Tag to filter plugins.
  • authorstring
    Username of an plugin author to filter plugins.
  • userstring
    Username to query for their favorites.
  • browsestring
    Browse view: 'popular', 'new', 'beta', 'recommended'.
  • localestring
    Locale to provide context-sensitive results. Default is the value of get_locale() .
  • installed_pluginsstring
    Installed plugins to provide context-sensitive results.
  • is_sslbool
    Whether links should be returned with https or not. Default false.
  • fieldsarray
    Array of fields which should or should not be returned.
    • short_descriptionbool
      Whether to return the plugin short description. Default true.
    • descriptionbool
      Whether to return the plugin full description. Default false.
    • sectionsbool
      Whether to return the plugin readme sections: description, installation, FAQ, screenshots, other notes, and changelog. Default false.
    • testedbool
      Whether to return the 'Compatible up to' value. Default true.
    • requiresbool
      Whether to return the required WordPress version. Default true.
    • requires_phpbool
      Whether to return the required PHP version. Default true.
    • ratingbool
      Whether to return the rating in percent and total number of ratings.
      Default true.
    • ratingsbool
      Whether to return the number of rating for each star (1-5). Default true.
    • downloadedbool
      Whether to return the download count. Default true.
    • downloadlinkbool
      Whether to return the download link for the package. Default true.
    • last_updatedbool
      Whether to return the date of the last update. Default true.
    • addedbool
      Whether to return the date when the plugin was added to the wordpress.org repository. Default true.
    • tagsbool
      Whether to return the assigned tags. Default true.
    • compatibilitybool
      Whether to return the WordPress compatibility list. Default true.
    • homepagebool
      Whether to return the plugin homepage link. Default true.
    • versionsbool
      Whether to return the list of all available versions. Default false.
    • donate_linkbool
      Whether to return the donation link. Default true.
    • reviewsbool
      Whether to return the plugin reviews. Default false.
    • bannersbool
      Whether to return the banner images links. Default false.
    • iconsbool
      Whether to return the icon links. Default false.
    • active_installsbool
      Whether to return the number of active installations. Default false.
    • groupbool
      Whether to return the assigned group. Default false.
    • contributorsbool
      Whether to return the list of contributors. Default false.

Default: array()


Top ↑

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.


Top ↑

Source

File: wp-admin/includes/plugin-install.php. View all references

function plugins_api( $action, $args = array() ) {
	// Include an unmodified $wp_version.
	require 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.
	 *
	 * 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.
	 *
	 * @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 = 'http://api.wordpress.org/plugins/info/1.2/';
		$url = add_query_arg(
			array(
				'action'  => $action,
				'request' => $args,
			),
			$url
		);

		$http_url = $url;
		$ssl      = wp_http_supports( array( 'ssl' ) );
		if ( $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 ) ) {
			if ( ! wp_is_json_request() ) {
				trigger_error(
					sprintf(
						/* translators: %s: Support forums URL. */
						__( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),
						__( 'https://wordpress.org/support/forums/' )
					) . ' ' . __( '(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&#8217;s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),
					__( 'https://wordpress.org/support/forums/' )
				),
				$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&#8217;s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),
						__( 'https://wordpress.org/support/forums/' )
					),
					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 );
}

Top ↑

Hooks



Top ↑

Changelog

Changelog
Version Description
2.7.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    Contributed by Marc Bernard

    Updated field list with defaults for $action = ‘plugin_information’:

    $fields = array(
    	'active_installs' => true,           // rounded int
    	'added' => true,                     // date
    	'author' => true,                    // a href html
    	'author_block_count' => true,        // int
    	'author_block_rating' => true,       // int
    	'author_profile' => true,            // url
    	'banners' => true,                   // array( [low], [high] )
    	'compatibility' => false,            // empty array?
    	'contributors' => true,              // array( array( [profile], [avatar], [display_name] )
    	'description' => false,              // string
    	'donate_link' => true,               // url
    	'download_link' => true,             // url
    	'downloaded' => false,               // int
    	// 'group' => false,                 // n/a 
    	'homepage' => true,                  // url
    	'icons' => false,                    // array( [1x] url, [2x] url )
    	'last_updated' => true,              // datetime
    	'name' => true,                      // string
    	'num_ratings' => true,               // int
    	'rating' => true,                    // int
    	'ratings' => true,                   // array( [5..0] )
    	'requires' => true,                  // version string
    	'requires_php' => true,              // version string
    	// 'reviews' => false,               // n/a, part of 'sections'
    	'screenshots' => true,               // array( array( [src], [caption] ) )
    	'sections' => true,                  // array( [description], [installation], [changelog], [reviews], ...)
    	'short_description' => false,        // string
    	'slug' => true,                      // string
    	'support_threads' => true,           // int
    	'support_threads_resolved' => true,  // int
    	'tags' => true,                      // array( )
    	'tested' => true,                    // version string
    	'version' => true,                   // version string
    	'versions' => true,                  // array( [version] url )
    );
  2. Skip to note 2 content
    Contributed by Andrei Surdu

    Get plugin data by URL or slug:

    function wpdev_get_plugin_data($urlOrSlug){
    	require_once( ABSPATH . 'wp-admin/includes/plugin-install.php' );
    	
    	$basename = str_replace('/', '', basename($urlOrSlug));
    
    	$info = plugins_api( 'plugin_information', array( 'slug' => $basename ) );
    
    	if ( ! $info or is_wp_error( $info ) ) {
    		return false;
    	}
    
    	return $info;
    }
    
    // Usage example
    $plugin_info = wpdev_get_plugin_data('https://wordpress.org/plugins/your-plugin-slug/'); // false or stdClass

You must log in before being able to contribute a note or feedback.