wp_get_popular_importers()
云策文档标注
概述
wp_get_popular_importers() 函数用于从 WordPress.org API 获取热门导入器插件列表,并返回包含元数据的数组。该函数实现了缓存机制以提高性能,并支持本地化翻译处理。
关键要点
- 函数返回一个数组,包含每个导入器的 slug、名称、描述、插件 slug 和 importer-id 等元数据。
- 使用缓存键(基于用户区域设置和 WordPress 版本)通过 get_site_transient() 和 set_site_transient() 缓存数据,有效期为 2 天。
- 通过 wp_remote_get() 请求 WordPress.org API 获取数据,支持 SSL 并设置用户代理。
- 如果 API 返回的数据已翻译,则直接返回;否则使用 translate() 函数对名称和描述进行本地化处理(WordPress 导入器名称除外)。
- 当 API 请求失败或返回非数组数据时,函数返回一个默认的导入器数组,包含 Blogger、Categories and Tags Converter 等常见导入器。
代码示例
// 示例:获取并显示热门导入器列表
$importers = wp_get_popular_importers();
if ( is_array( $importers ) ) {
foreach ( $importers as $slug => $importer ) {
echo 'Slug: ' . $slug . ' - Name: ' . $importer['name'] . ' - Description: ' . $importer['description'] . '<br>';
}
}注意事项
- 函数依赖于 WordPress.org API 的可用性,如果 API 不可用,将返回默认的硬编码导入器列表。
- 缓存机制基于用户区域设置和 WordPress 版本,确保不同环境和语言下的数据隔离。
- 在翻译处理中,WordPress 导入器的名称保持原样(不翻译),而其他导入器的名称和描述会根据区域设置进行翻译。
- 使用此函数时,需确保服务器支持 HTTP 请求和 SSL(如果可用),以正常获取远程数据。
原文内容
Returns a list from WordPress.org of popular importer plugins.
Source
function wp_get_popular_importers() {
$locale = get_user_locale();
$cache_key = 'popular_importers_' . md5( $locale . wp_get_wp_version() );
$popular_importers = get_site_transient( $cache_key );
if ( ! $popular_importers ) {
$url = add_query_arg(
array(
'locale' => $locale,
'version' => wp_get_wp_version(),
),
'https://api.wordpress.org/core/importers/1.1/'
);
$options = array( 'user-agent' => 'WordPress/' . wp_get_wp_version() . '; ' . home_url( '/' ) );
if ( wp_http_supports( array( 'ssl' ) ) ) {
$url = set_url_scheme( $url, 'https' );
}
$response = wp_remote_get( $url, $options );
$popular_importers = json_decode( wp_remote_retrieve_body( $response ), true );
if ( is_array( $popular_importers ) ) {
set_site_transient( $cache_key, $popular_importers, 2 * DAY_IN_SECONDS );
} else {
$popular_importers = false;
}
}
if ( is_array( $popular_importers ) ) {
// If the data was received as translated, return it as-is.
if ( $popular_importers['translated'] ) {
return $popular_importers['importers'];
}
foreach ( $popular_importers['importers'] as &$importer ) {
// phpcs:ignore WordPress.WP.I18n.LowLevelTranslationFunction,WordPress.WP.I18n.NonSingularStringLiteralText
$importer['description'] = translate( $importer['description'] );
if ( 'WordPress' !== $importer['name'] ) {
// phpcs:ignore WordPress.WP.I18n.LowLevelTranslationFunction,WordPress.WP.I18n.NonSingularStringLiteralText
$importer['name'] = translate( $importer['name'] );
}
}
return $popular_importers['importers'];
}
return array(
// slug => name, description, plugin slug, and register_importer() slug.
'blogger' => array(
'name' => __( 'Blogger' ),
'description' => __( 'Import posts, comments, and users from a Blogger blog.' ),
'plugin-slug' => 'blogger-importer',
'importer-id' => 'blogger',
),
'wpcat2tag' => array(
'name' => __( 'Categories and Tags Converter' ),
'description' => __( 'Convert existing categories to tags or tags to categories, selectively.' ),
'plugin-slug' => 'wpcat2tag-importer',
'importer-id' => 'wp-cat2tag',
),
'livejournal' => array(
'name' => __( 'LiveJournal' ),
'description' => __( 'Import posts from LiveJournal using their API.' ),
'plugin-slug' => 'livejournal-importer',
'importer-id' => 'livejournal',
),
'movabletype' => array(
'name' => __( 'Movable Type and TypePad' ),
'description' => __( 'Import posts and comments from a Movable Type or TypePad blog.' ),
'plugin-slug' => 'movabletype-importer',
'importer-id' => 'mt',
),
'rss' => array(
'name' => __( 'RSS' ),
'description' => __( 'Import posts from an RSS feed.' ),
'plugin-slug' => 'rss-importer',
'importer-id' => 'rss',
),
'tumblr' => array(
'name' => __( 'Tumblr' ),
'description' => __( 'Import posts & media from Tumblr using their API.' ),
'plugin-slug' => 'tumblr-importer',
'importer-id' => 'tumblr',
),
'wordpress' => array(
'name' => 'WordPress',
'description' => __( 'Import posts, pages, comments, custom fields, categories, and tags from a WordPress export file.' ),
'plugin-slug' => 'wordpress-importer',
'importer-id' => 'wordpress',
),
);
}
Changelog
| Version | Description |
|---|---|
| 3.5.0 | Introduced. |