themes_api()
概述
themes_api() 函数用于从 WordPress.org 主题 API 检索主题安装页面信息。它支持多种操作和参数,并提供了三个过滤器供主题或插件覆盖 API 结果,使用时需谨慎处理。
关键要点
- 函数用途:从 WordPress.org 主题 API 获取主题安装页面数据,支持 query_themes、theme_information、hot_tags 和 feature_list 四种操作。
- 参数说明:$action 参数指定操作类型,$args 参数为数组或对象,包含 slug、per_page、page、number、search、tag、author、user、browse、locale、fields 等,具体支持情况因操作而异。
- 过滤器机制:提供三个过滤器:'themes_api_args' 用于过滤查询参数,'themes_api' 可完全覆盖 API 请求,'themes_api_result' 用于过滤响应结果;使用时需注意返回类型(对象或数组)与 $action 匹配。
- 返回类型:成功时返回对象或数组,失败时返回 WP_Error;具体结构取决于 $action 值。
- 内部处理:函数自动设置默认参数(如 per_page、locale、wp_version),处理 SSL 连接,并兼容 API 版本差异(如对象转换)。
代码示例
$theme_slug = 'plugin-slug-name';
if ( ! function_exists( 'themes_api' ) ) {
require_once( ABSPATH . 'wp-admin/includes/theme.php' );
}
if ( ! empty( $theme_slug ) ) {
$args = array(
'slug' => $theme_slug,
);
}
/** Prepare our query */
$call_api = themes_api( 'theme_information', $args );注意事项
- 使用过滤器时需谨慎:'themes_api_args' 必须返回对象;'themes_api' 覆盖时,根据 $action 返回对象(query_themes、theme_information、feature_list)或数组(hot_tags)。
- 参数默认值:例如 per_page 默认 24,locale 默认 get_user_locale(),需在查询前设置以避免意外行为。
- 错误处理:函数可能返回 WP_Error,调用时应检查并处理错误情况。
Retrieves theme installer pages from the WordPress.org Themes API.
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
$actionstringrequired-
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.
slugstringThe theme slug.per_pageintNumber of themes per page. Default 24.pageintNumber of current page. Default 1.numberintNumber of tags to be queried.searchstringA search term.tagstringTag to filter themes.authorstringUsername of an author to filter themes.userstringUsername to query for their favorites.browsestringBrowse view:'featured','popular','updated','favorites'.localestringLocale to provide context-sensitive results. Default is the value of get_locale() .fieldsarrayArray of fields which should or should not be returned.descriptionboolWhether to return the theme full description. Default false.sectionsboolWhether to return the theme readme sections: description, installation, FAQ, screenshots, other notes, and changelog. Default false.ratingboolWhether to return the rating in percent and total number of ratings.
Default false.ratingsboolWhether to return the number of rating for each star (1-5). Default false.downloadedboolWhether to return the download count. Default false.downloadlinkboolWhether to return the download link for the package. Default false.last_updatedboolWhether to return the date of the last update. Default false.tagsboolWhether to return the assigned tags. Default false.homepageboolWhether to return the theme homepage link. Default false.screenshotsboolWhether to return the screenshots. Default false.screenshot_countintNumber of screenshots to return. Default 1.screenshot_urlboolWhether to return the URL of the first screenshot. Default false.photon_screenshotsboolWhether to return the screenshots via Photon. Default false.templateboolWhether to return the slug of the parent theme. Default false.parentboolWhether to return the slug, name and homepage of the parent theme. Default false.versionsboolWhether to return the list of all available versions. Default false.theme_urlboolWhether to return theme’s URL. Default false.extended_authorboolWhether to return nicename or nicename and display name. Default false.
Default:
array()Source
function themes_api( $action, $args = array() ) { if ( is_array( $args ) ) { $args = (object) $args; } if ( 'query_themes' === $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_get_wp_version(), 0, 3 ); // x.y } /** * 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. * * 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. * * @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 ) { $url = 'https://api.wordpress.org/themes/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_get_wp_version() . '; ' . home_url( '/' ), ); $request = wp_remote_get( $url, $http_args ); if ( $ssl && is_wp_error( $request ) ) { if ( ! wp_doing_ajax() ) { wp_trigger_error( __FUNCTION__, sprintf( /* translators: %s: Support forums URL. */ __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server’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( 'themes_api_failed', sprintf( /* translators: %s: Support forums URL. */ __( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server’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 ); if ( is_array( $res ) ) { // Object casting is required in order to match the info/1.0 format. $res = (object) $res; } elseif ( null === $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’s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ), __( 'https://wordpress.org/support/forums/' ) ), wp_remote_retrieve_body( $request ) ); } if ( isset( $res->error ) ) { $res = new WP_Error( 'themes_api_failed', $res->error ); } } if ( ! is_wp_error( $res ) ) { // Back-compat for info/1.2 API, upgrade the theme objects in query_themes to objects. if ( 'query_themes' === $action ) { foreach ( $res->themes as $i => $theme ) { $res->themes[ $i ] = (object) $theme; } } // Back-compat for info/1.2 API, downgrade the feature_list result back to an array. if ( 'feature_list' === $action ) { $res = (array) $res; } } } /** * Filters the returned WordPress.org Themes API response. * * @since 2.8.0 * * @param array|stdClass|WP_Error $res WordPress.org Themes API response. * @param string $action Requested action. Likely values are 'theme_information', * 'feature_list', or 'query_themes'. * @param stdClass $args Arguments used to query for installer pages from the WordPress.org Themes API. */ return apply_filters( 'themes_api_result', $res, $action, $args ); }Hooks
- apply_filters( ‘themes_api’, false|object|array $override, string $action, object $args )
-
Filters whether to override the WordPress.org Themes API.
- apply_filters( ‘themes_api_args’, object $args, string $action )
-
Filters arguments used to query for installer pages from the WordPress.org Themes API.
- apply_filters( ‘themes_api_result’, array|stdClass|WP_Error $res, string $action, stdClass $args )
-
Filters the returned WordPress.org Themes API response.
Changelog
Version Description 2.8.0 Introduced. User Contributed Notes
You must log in before being able to contribute a note or feedback.
Skip to note 2 content
Meet Makadia
$theme_slug = 'plugin-slug-name'; if ( ! function_exists( 'themes_api' ) ) { require_once( ABSPATH . 'wp-admin/includes/theme.php' ); } if ( ! empty( $theme_slug ) ) { $args = array( 'slug' => $theme_slug, ); } /** Prepare our query */ $call_api = themes_api( 'theme_information', $args );