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

Description

Parameters

$actionstring

API action to perform: 'query_plugins', 'plugin_information', or 'hot_tags'.

$argsarray|objectoptional

Array or object of arguments to serialize for the Plugin Info API.Default: array()

• $slugstringdefault: empty

  The plugin slug.

• $per_pageintdefault: 24

  Number of plugins per page.

• $pageintdefault: 1

  Number of current page.

• $numberint

  Number of tags or categories to be queried.

• $searchstringdefault: empty

  A search term.

• $tagstringdefault: empty

  Tag to filter plugins.

• $authorstringdefault: empty

  Username of an plugin author to filter plugins.

• $userstringdefault: empty

  Username to query for their favorites.

• $browsestring

  Browse view: 'popular', 'new', 'beta', 'recommended'.

• $localestringdefault: is the value of get_locale()

  Locale to provide context-sensitive results.

• $installed_pluginsstring

  Installed plugins to provide context-sensitive results.

• $is_sslbooldefault: false

  Whether links should be returned with https or not.

• $fieldsarray

  { Array of fields which should or should not be returned.

• $short_descriptionbooldefault: true

  Whether to return the plugin short description.

• $descriptionbooldefault: false

  Whether to return the plugin full description.

• $sectionsbooldefault: false

  Whether to return the plugin readme sections: description, installation, FAQ, screenshots, other notes, and changelog.

• $testedbooldefault: true

  Whether to return the 'Compatible up to' value.

• $requiresbooldefault: true

  Whether to return the required WordPress version.

• $requires_phpbooldefault: true

  Whether to return the required PHP version.

• $ratingbooldefault: true

  Whether to return the rating in percent and total number of ratings.

• $ratingsbooldefault: true

  Whether to return the number of rating for each star (1-5).

• $downloadedbooldefault: true

  Whether to return the download count.

• $downloadlinkbooldefault: true

  Whether to return the download link for the package.

• $last_updatedbooldefault: true

  Whether to return the date of the last update.

• $addedbooldefault: true

  Whether to return the date when the plugin was added to the wordpress.org repository.

• $tagsbooldefault: true

  Whether to return the assigned tags.

• $compatibilitybooldefault: true

  Whether to return the WordPress compatibility list.

• $homepagebooldefault: true

  Whether to return the plugin homepage link.

• $versionsbooldefault: false

  Whether to return the list of all available versions.

• $donate_linkbooldefault: true

  Whether to return the donation link.

• $reviewsbooldefault: false

  Whether to return the plugin reviews.

• $bannersbooldefault: false

  Whether to return the banner images links.

• $iconsbooldefault: false

  Whether to return the icon links.

• $active_installsbooldefault: false

  Whether to return the number of active installations.

• $contributorsbooldefault: false. }

  Whether to return the list of contributors.

Return

object|array|WP_Error

Response object or array on success, WP_Error on failure. See the <a href="https://developer.wordpress.org/reference/functions/plugins_api/">https://developer.wordpress.org/reference/functions/plugins_api/</a> function reference article for more information on the make-up of possible return values depending on the value of $action.

Hooks fired · 3

3 hooks fire while plugins_api() runs, in this order:

1. 1
   apply_filters( plugins_api_args )filterline 129 (+29 into the body)

   Filters the WordPress.org Plugin Installation API arguments.

2. 2
   apply_filters( plugins_api )filterline 145 (+45 into the body)

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

3. 3
   apply_filters( plugins_api_result )filterline 230 (+130 into the body)

   Filters the Plugin Installation API response results.

Uses · 14

• get_user_locale()Retrieves the locale of a user.
• wp_get_wp_version()Returns the current WordPress version.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• add_query_arg()Retrieves a modified URL query string.
• wp_http_supports()Determines if there is an HTTP Transport that can process this request.
• set_url_scheme()Sets the scheme for a URL.
• home_url()Retrieves the URL for the current site where the front end is accessible.
• wp_remote_get()Performs an HTTP request using the GET method and returns its response.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_is_json_request()Checks whether current request is a JSON request, or is expecting a JSON response.
• wp_trigger_error()Generates a user-level error/warning/notice/deprecation message.
• __()Retrieves the translation of $text.

Used by · 8

• WP_Plugin_Dependencies::get_dependency_api_data()Retrieves and stores dependency plugin data from the WordPress.org Plugin API.
• WP_Plugin_Install_List_Table::get_dependencies_notice()Returns a notice containing a list of dependencies required by the plugin.
• WP_Plugin_Install_List_Table::prepare_items()
• WP_REST_Block_Directory_Controller::get_items()Search and retrieve blocks metadata
• WP_REST_Plugins_Controller::create_item()Uploads a plugin and optionally activates it.
• install_plugin_information()Displays plugin information in dialog box form.
• install_popular_tags()Retrieves popular WordPress plugin tags.
• wp_ajax_install_plugin()Handles installing a plugin via AJAX.

Source

View on Trac ↗View on GitHub ↗

100function plugins_api( $action, $args = array() ) {101	if ( is_array( $args ) ) {102		$args = (object) $args;103	}104 105	if ( 'query_plugins' === $action ) {106		if ( ! isset( $args->per_page ) ) {107			$args->per_page = 24;108		}109	}110 111	if ( ! isset( $args->locale ) ) {112		$args->locale = get_user_locale();113	}114 115	if ( ! isset( $args->wp_version ) ) {116		$args->wp_version = substr( wp_get_wp_version(), 0, 3 ); // x.y117	}118 119	/**120	 * Filters the WordPress.org Plugin Installation API arguments.121	 *122	 * Important: An object MUST be returned to this filter.123	 *124	 * @since 2.7.0125	 *126	 * @param object $args   Plugin API arguments.127	 * @param string $action The type of information being requested from the Plugin Installation API.128	 */129	$args = apply_filters( 'plugins_api_args', $args, $action );130 131	/**132	 * Filters the response for the current WordPress.org Plugin Installation API request.133	 *134	 * Returning a non-false value will effectively short-circuit the WordPress.org API request.135	 *136	 * If `$action` is 'query_plugins' or 'plugin_information', an object MUST be passed.137	 * If `$action` is 'hot_tags', an array should be passed.138	 *139	 * @since 2.7.0140	 *141	 * @param false|object|array $result The result object or array. Default false.142	 * @param string             $action The type of information being requested from the Plugin Installation API.143	 * @param object             $args   Plugin API arguments.144	 */145	$res = apply_filters( 'plugins_api', false, $action, $args );146 147	if ( false === $res ) {148 149		$url = 'http://api.wordpress.org/plugins/info/1.2/';150		$url = add_query_arg(151			array(152				'action'  => $action,153				'request' => $args,154			),155			$url156		);157 158		$http_url = $url;159		$ssl      = wp_http_supports( array( 'ssl' ) );160		if ( $ssl ) {161			$url = set_url_scheme( $url, 'https' );162		}163 164		$http_args = array(165			'timeout'    => 15,166			'user-agent' => 'WordPress/' . wp_get_wp_version() . '; ' . home_url( '/' ),167		);168		$request   = wp_remote_get( $url, $http_args );169 170		if ( $ssl && is_wp_error( $request ) ) {171			if ( ! wp_is_json_request() ) {172				wp_trigger_error(173					__FUNCTION__,174					sprintf(175						/* translators: %s: Support forums URL. */176						__( '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>.' ),177						__( 'https://wordpress.org/support/forums/' )178					) . ' ' . __( '(WordPress could not establish a secure connection to WordPress.org. Please contact your server administrator.)' ),179					headers_sent() || WP_DEBUG ? E_USER_WARNING : E_USER_NOTICE

History

Introduced in 2.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-admin/includes/plugin-install.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.