wp_sitemaps_get_server()
云策文档标注
概述
wp_sitemaps_get_server() 函数用于获取当前的 Sitemaps 服务器实例。如果全局实例不存在,它会初始化并启动 Sitemaps 系统。
关键要点
- 函数返回 WP_Sitemaps 实例,用于管理站点地图功能。
- 当全局变量 $wp_sitemaps 为空时,会创建新实例并调用 init() 方法进行初始化。
- 在初始化过程中,会触发 wp_sitemaps_init 钩子,允许注册额外的站点地图提供者。
代码示例
function wp_sitemaps_get_server() {
global $wp_sitemaps;
// If there isn't a global instance, set and bootstrap the sitemaps system.
if ( empty( $wp_sitemaps ) ) {
$wp_sitemaps = new WP_Sitemaps();
$wp_sitemaps->init();
/**
* Fires when initializing the Sitemaps object.
*
* Additional sitemaps should be registered on this hook.
*
* @since 5.5.0
*
* @param WP_Sitemaps $wp_sitemaps Sitemaps object.
*/
do_action( 'wp_sitemaps_init', $wp_sitemaps );
}
return $wp_sitemaps;
}注意事项
此函数在 WordPress 5.5.0 版本中引入,是站点地图功能的核心部分,常用于获取或初始化站点地图服务器。
原文内容
Retrieves the current Sitemaps server instance.
Source
function wp_sitemaps_get_server() {
global $wp_sitemaps;
// If there isn't a global instance, set and bootstrap the sitemaps system.
if ( empty( $wp_sitemaps ) ) {
$wp_sitemaps = new WP_Sitemaps();
$wp_sitemaps->init();
/**
* Fires when initializing the Sitemaps object.
*
* Additional sitemaps should be registered on this hook.
*
* @since 5.5.0
*
* @param WP_Sitemaps $wp_sitemaps Sitemaps object.
*/
do_action( 'wp_sitemaps_init', $wp_sitemaps );
}
return $wp_sitemaps;
}
Hooks
- do_action( ‘wp_sitemaps_init’, WP_Sitemaps $wp_sitemaps )
-
Fires when initializing the Sitemaps object.
Changelog
| Version | Description |
|---|---|
| 5.5.0 | Introduced. |