themes_api │ filter-hook │ WP 2.8.0

Filters whether to override the WordPress.org Themes API.

Returning 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.

Usage

add_filter( 'themes_api', 'wp_kama_themes_api_filter', 10, 3 );

/**
 * Function for `themes_api` filter-hook.
 * 
 * @param false|object|array $override Whether to override the WordPress.org Themes API.
 * @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.
 *
 * @return false|object|array
 */
function wp_kama_themes_api_filter( $override, $action, $args ){

	// filter...
	return $override;
}

$override(false|object|array)

Whether to override the WordPress.org Themes API.
Default: false

$action(string)

Requested action. Likely values are 'theme_information', 'feature_list', or 'query_themes'.

$args(object)

Arguments used to query for installer pages from the Themes API.

Changelog

Where the hook is called

$res = apply_filters( 'themes_api', false, $action, $args );

Where the hook is used in WordPress