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

Description

Parameters

$actionstring

API action to perform: Accepts 'query_themes', 'theme_information', 'hot_tags' or 'feature_list'.

$argsarray|objectoptional

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

• $slugstringdefault: empty

  The theme slug.

• $per_pageintdefault: 24

  Number of themes per page.

• $pageintdefault: 1

  Number of current page.

• $numberint

  Number of tags to be queried.

• $searchstringdefault: empty

  A search term.

• $tagstringdefault: empty

  Tag to filter themes.

• $authorstringdefault: empty

  Username of an author to filter themes.

• $userstringdefault: empty

  Username to query for their favorites.

• $browsestring

  Browse view: 'featured', 'popular', 'updated', 'favorites'.

• $localestringdefault: is the value of get_locale()

  Locale to provide context-sensitive results.

• $fieldsarray

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

• $descriptionbooldefault: false

  Whether to return the theme full description.

• $sectionsbooldefault: false

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

• $ratingbooldefault: false

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

• $ratingsbooldefault: false

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

• $downloadedbooldefault: false

  Whether to return the download count.

• $downloadlinkbooldefault: false

  Whether to return the download link for the package.

• $last_updatedbooldefault: false

  Whether to return the date of the last update.

• $tagsbooldefault: false

  Whether to return the assigned tags.

• $homepagebooldefault: false

  Whether to return the theme homepage link.

• $screenshotsbooldefault: false

  Whether to return the screenshots.

• $screenshot_countintdefault: 1

  Number of screenshots to return.

• $screenshot_urlbooldefault: false

  Whether to return the URL of the first screenshot.

• $photon_screenshotsbooldefault: false

  Whether to return the screenshots via Photon.

• $templatebooldefault: false

  Whether to return the slug of the parent theme.

• $parentbooldefault: false

  Whether to return the slug, name and homepage of the parent theme.

• $versionsbooldefault: false

  Whether to return the list of all available versions.

• $theme_urlbooldefault: false

  Whether to return theme's URL.

• $extended_authorbooldefault: false. }

  Whether to return nicename or nicename and display name.

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/themes_api/">https://developer.wordpress.org/reference/functions/themes_api/</a> function reference article for more information on the make-up of possible return objects depending on the value of $action.

Hooks fired · 3

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

1. 1
   apply_filters( themes_api_args )filterline 521 (+30 into the body)

   Filters arguments used to query for installer pages from the WordPress.org Themes API.

2. 2
   apply_filters( themes_api )filterline 538 (+47 into the body)

   Filters whether to override the WordPress.org Themes API.

3. 3
   apply_filters( themes_api_result )filterline 634 (+143 into the body)

   Filters the returned WordPress.org Themes API response.

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_doing_ajax()Determines whether the current request is a WordPress Ajax request.
• wp_trigger_error()Generates a user-level error/warning/notice/deprecation message.
• __()Retrieves the translation of $text.

Used by · 8

• Theme_Upgrader::check_parent_theme_filter()Checks if a child theme is being installed and its parent also needs to be installed.
• WP_Customize_Manager::handle_load_themes_request()Loads themes into the theme browsing/installation UI.
• WP_Theme_Install_List_Table::prepare_items()
• get_theme_feature_list()Retrieves list of WordPress theme features (aka theme tags).
• install_theme_information()Displays theme information in dialog box form.
• install_themes_feature_list()Retrieves the list of WordPress theme features (aka theme tags).
• wp_ajax_install_theme()Handles installing a theme via AJAX.
• wp_ajax_query_themes()Handles getting themes from themes_api() via AJAX.

Source

View on Trac ↗View on GitHub ↗

491function themes_api( $action, $args = array() ) {492	if ( is_array( $args ) ) {493		$args = (object) $args;494	}495 496	if ( 'query_themes' === $action ) {497		if ( ! isset( $args->per_page ) ) {498			$args->per_page = 24;499		}500	}501 502	if ( ! isset( $args->locale ) ) {503		$args->locale = get_user_locale();504	}505 506	if ( ! isset( $args->wp_version ) ) {507		$args->wp_version = substr( wp_get_wp_version(), 0, 3 ); // x.y508	}509 510	/**511	 * Filters arguments used to query for installer pages from the WordPress.org Themes API.512	 *513	 * Important: An object MUST be returned to this filter.514	 *515	 * @since 2.8.0516	 *517	 * @param object $args   Arguments used to query for installer pages from the WordPress.org Themes API.518	 * @param string $action Requested action. Likely values are 'theme_information',519	 *                       'feature_list', or 'query_themes'.520	 */521	$args = apply_filters( 'themes_api_args', $args, $action );522 523	/**524	 * Filters whether to override the WordPress.org Themes API.525	 *526	 * Returning a non-false value will effectively short-circuit the WordPress.org API request.527	 *528	 * If `$action` is 'query_themes', 'theme_information', or 'feature_list', an object MUST529	 * be passed. If `$action` is 'hot_tags', an array should be passed.530	 *531	 * @since 2.8.0532	 *533	 * @param false|object|array $override Whether to override the WordPress.org Themes API. Default false.534	 * @param string             $action   Requested action. Likely values are 'theme_information',535	 *                                    'feature_list', or 'query_themes'.536	 * @param object             $args     Arguments used to query for installer pages from the Themes API.537	 */538	$res = apply_filters( 'themes_api', false, $action, $args );539 540	if ( ! $res ) {541		$url = 'http://api.wordpress.org/themes/info/1.2/';542		$url = add_query_arg(543			array(544				'action'  => $action,545				'request' => $args,546			),547			$url548		);549 550		$http_url = $url;551		$ssl      = wp_http_supports( array( 'ssl' ) );552		if ( $ssl ) {553			$url = set_url_scheme( $url, 'https' );554		}555 556		$http_args = array(557			'timeout'    => 15,558			'user-agent' => 'WordPress/' . wp_get_wp_version() . '; ' . home_url( '/' ),559		);560		$request   = wp_remote_get( $url, $http_args );561 562		if ( $ssl && is_wp_error( $request ) ) {563			if ( ! wp_doing_ajax() ) {564				wp_trigger_error(565					__FUNCTION__,566					sprintf(567						/* translators: %s: Support forums URL. */568						__( '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>.' ),569						__( 'https://wordpress.org/support/forums/' )570					) . ' ' . __( '(WordPress could not establish a secure connection to WordPress.org. Please contact your server administrator.)' ),

History

Introduced in 2.8.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 7.0.4 tag, from src/wp-admin/includes/theme.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.