wp_register_sitemap_provider()
云策文档标注
概述
wp_register_sitemap_provider() 函数用于在 WordPress 中注册一个新的站点地图提供者,通过将提供者实例添加到站点地图服务器注册表中来实现。
关键要点
- 函数接受两个参数:$name(字符串,必需,提供者的唯一名称)和 $provider(WP_Sitemaps_Provider 实例,必需,实现站点地图的提供者)。
- 返回布尔值,表示站点地图是否成功添加。
- 内部调用 wp_sitemaps_get_server() 获取站点地图服务器实例,然后通过其注册表添加提供者。
- 此函数自 WordPress 5.5.0 版本引入。
代码示例
function wp_register_sitemap_provider( $name, WP_Sitemaps_Provider $provider ) {
$sitemaps = wp_sitemaps_get_server();
return $sitemaps->registry->add_provider( $name, $provider );
}注意事项
- 确保 $name 参数是唯一的,以避免冲突。
- $provider 必须是 WP_Sitemaps_Provider 类的实例,并正确实现站点地图功能。
- 相关函数 wp_sitemaps_get_server() 用于检索当前站点地图服务器实例。
原文内容
Registers a new sitemap provider.
Parameters
$namestringrequired-
Unique name for the sitemap provider.
$providerWP_Sitemaps_Providerrequired-
The
Sitemaps_Providerinstance implementing the sitemap.
Source
function wp_register_sitemap_provider( $name, WP_Sitemaps_Provider $provider ) {
$sitemaps = wp_sitemaps_get_server();
return $sitemaps->registry->add_provider( $name, $provider );
}
Changelog
| Version | Description |
|---|---|
| 5.5.0 | Introduced. |