plugins_api() - Retrieves plugin installer pages from the WordPress.org Plugins API.

plugins_api() – Retrieves plugin installer pages from the WordPress.org Plugins API.

You appear to be a bot. Output may be restricted

Description

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

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

Usage

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

Parameters

$action: ( string ) required – API action to perform: 'query_plugins', 'plugin_information', 'hot_tags' or 'hot_categories'.
$args: ( array|object ) optional – { Optional. Array or object of arguments to serialize for the Plugin Info API.

Returns

object|array|WP_Error Response object or array on success, WP_Error on failure. See the https://developer.wordpress.org/reference/functions/plugins_api/ for more information on the make-up of possible return values depending on the value of `$action`.

Source

File name: wordpress/wp-admin/includes/plugin-install.php
Lines:

1 to 100 of 134

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 );

[1] [2] Next »

View on GitHub View on Trac