themes_api( string $action, array|object $args = array() )

Retrieves theme installer pages from the WordPress.org Themes API.


Description Description

It is possible for a theme to override the Themes API result with three filters. Assume this is for themes, which can extend on the Theme Info to offer more choices. This is very powerful and must be used with care, when overriding the filters.

The first filter, ‘themes_api_args’, is for the args and gives the action as the second parameter. The hook for ‘themes_api_args’ must ensure that an object is returned.

The second filter, ‘themes_api’, allows a plugin to override the WordPress.org Theme API entirely. If $action is ‘query_themes’, ‘theme_information’, or ‘feature_list’, an object MUST be passed. If $action is ‘hot_tags’, an array should be passed.

Finally, the third filter, ‘themes_api_result’, makes it possible to filter the response object or array, depending on the $action type.

Supported arguments per action:

Argument Name ‘query_themes’ ‘theme_information’ ‘hot_tags’ ‘feature_list’
$slug No Yes No No
$per_page Yes No No No
$page Yes No No No
$number No No Yes No
$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
$fields Yes Yes No No

Parameters Parameters

$action

(string) (Required) API action to perform: 'query_themes', 'theme_information', 'hot_tags' or 'feature_list'.

$args

(array|object) (Optional) Array or object of arguments to serialize for the Themes API.

  • 'slug'
    (string) The theme slug.
  • 'per_page'
    (int) Number of themes per page. Default 24.
  • 'page'
    (int) Number of current page. Default 1.
  • 'number'
    (int) Number of tags to be queried.
  • 'search'
    (string) A search term.
  • 'tag'
    (string) Tag to filter themes.
  • 'author'
    (string) Username of an author to filter themes.
  • 'user'
    (string) Username to query for their favorites.
  • 'browse'
    (string) Browse view: 'featured', 'popular', 'updated', 'favorites'.
  • 'locale'
    (string) Locale to provide context-sensitive results. Default is the value of get_locale().
  • 'fields'
    (array) Array of fields which should or should not be returned.
    • 'description'
      (bool) Whether to return the theme full description. Default false.
    • 'sections'
      (bool) Whether to return the theme readme sections: description, installation, FAQ, screenshots, other notes, and changelog. Default false.
    • 'rating'
      (bool) Whether to return the rating in percent and total number of ratings. Default false.
    • 'ratings'
      (bool) Whether to return the number of rating for each star (1-5). Default false.
    • 'downloaded'
      (bool) Whether to return the download count. Default false.
    • 'downloadlink'
      (bool) Whether to return the download link for the package. Default false.
    • 'last_updated'
      (bool) Whether to return the date of the last update. Default false.
    • 'tags'
      (bool) Whether to return the assigned tags. Default false.
    • 'homepage'
      (bool) Whether to return the theme homepage link. Default false.
    • 'screenshots'
      (bool) Whether to return the screenshots. Default false.
    • 'screenshot_count'
      (int) Number of screenshots to return. Default 1.
    • 'screenshot_url'
      (bool) Whether to return the URL of the first screenshot. Default false.
    • 'photon_screenshots'
      (bool) Whether to return the screenshots via Photon. Default false.
    • 'template'
      (bool) Whether to return the slug of the parent theme. Default false.
    • 'parent'
      (bool) Whether to return the slug, name and homepage of the parent theme. Default false.
    • 'versions'
      (bool) Whether to return the list of all available versions. Default false.
    • 'theme_url'
      (bool) Whether to return theme's URL. Default false.
    • 'extended_author'
      (bool) Whether to return nicename or nicename and display name. Default false.

Default value: array()


Top ↑

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 objects depending on the value of $action.


Top ↑

Source Source

File: wp-admin/includes/theme.php

function themes_api( $action, $args = array() ) {

	if ( is_array( $args ) ) {
		$args = (object) $args;
	}

	if ( ! isset( $args->per_page ) ) {
		$args->per_page = 24;
	}

	if ( ! isset( $args->locale ) ) {
		$args->locale = get_user_locale();
	}

	/**
	 * Filters arguments used to query for installer pages from the WordPress.org Themes API.
	 *
	 * Important: An object MUST be returned to this filter.
	 *
	 * @since 2.8.0
	 *
	 * @param object $args   Arguments used to query for installer pages from the WordPress.org Themes API.
	 * @param string $action Requested action. Likely values are 'theme_information',
	 *                       'feature_list', or 'query_themes'.
	 */
	$args = apply_filters( 'themes_api_args', $args, $action );

	/**
	 * Filters whether to override the WordPress.org Themes API.
	 *
	 * Passing a non-false value will effectively short-circuit the WordPress.org API request.
	 *
	 * If `$action` is 'query_themes', 'theme_information', or 'feature_list', an object MUST
	 * be passed. If `$action` is 'hot_tags', an array should be passed.
	 *
	 * @since 2.8.0
	 *
	 * @param false|object|array $override Whether to override the WordPress.org Themes API. Default false.
	 * @param string             $action   Requested action. Likely values are 'theme_information',
	 *                                    'feature_list', or 'query_themes'.
	 * @param object             $args     Arguments used to query for installer pages from the Themes API.
	 */
	$res = apply_filters( 'themes_api', false, $action, $args );

	if ( ! $res ) {
		// include an unmodified $wp_version
		include( ABSPATH . WPINC . '/version.php' );

		$url = $http_url = 'http://api.wordpress.org/themes/info/1.0/';
		if ( $ssl = wp_http_supports( array( 'ssl' ) ) )
			$url = set_url_scheme( $url, 'https' );

		$http_args = array(
			'user-agent' => 'WordPress/' . $wp_version . '; ' . home_url( '/' ),
			'body' => array(
				'action' => $action,
				'request' => serialize( $args )
			)
		);
		$request = wp_remote_post( $url, $http_args );

		if ( $ssl && is_wp_error( $request ) ) {
			if ( ! wp_doing_ajax() ) {
				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/' )
					) . ' ' . __( '(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_post( $http_url, $http_args );
		}

		if ( is_wp_error($request) ) {
			$res = new WP_Error( 'themes_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/' )
				),
				$request->get_error_message()
			);
		} else {
			$res = maybe_unserialize( wp_remote_retrieve_body( $request ) );
			if ( ! is_object( $res ) && ! is_array( $res ) ) {
				$res = new WP_Error( 'themes_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/' )
					),
					wp_remote_retrieve_body( $request )
				);
			}
		}
	}

	/**
	 * Filters the returned WordPress.org Themes API response.
	 *
	 * @since 2.8.0
	 *
	 * @param array|object|WP_Error $res    WordPress.org Themes API response.
	 * @param string                $action Requested action. Likely values are 'theme_information',
	 *                                      'feature_list', or 'query_themes'.
	 * @param object                $args   Arguments used to query for installer pages from the WordPress.org Themes API.
	 */
	return apply_filters( 'themes_api_result', $res, $action, $args );
}

Top ↑

Changelog Changelog

Changelog
Version Description
2.8.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

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