WP_Sitemaps_Registry
云策文档标注
概述
WP_Sitemaps_Registry 是 WordPress 5.5.0 引入的类，用于管理站点地图提供者的注册和检索。它提供方法来添加、获取单个或所有提供者，确保站点地图系统的可扩展性。
关键要点
- WP_Sitemaps_Registry 类用于注册和管理 WP_Sitemaps_Provider 实例。
- 主要方法包括 add_provider() 添加提供者、get_provider() 获取单个提供者、get_providers() 获取所有提供者。
- 添加提供者时使用 wp_sitemaps_add_provider 过滤器进行过滤，并检查提供者类型。
- 私有属性 $providers 存储已注册的提供者数组。
代码示例
public function add_provider( $name, WP_Sitemaps_Provider $provider ) {
if ( isset( $this->providers[ $name ] ) ) {
return false;
}
$provider = apply_filters( 'wp_sitemaps_add_provider', $provider, $name );
if ( ! $provider instanceof WP_Sitemaps_Provider ) {
return false;
}
$this->providers[ $name ] = $provider;
return true;
}
原文内容
Class WP_Sitemaps_Registry.
Methods
| Name | Description |
|---|---|
| WP_Sitemaps_Registry::add_provider | Adds a new sitemap provider. |
| WP_Sitemaps_Registry::get_provider | Returns a single registered sitemap provider. |
| WP_Sitemaps_Registry::get_providers | Returns all registered sitemap providers. |
Source
class WP_Sitemaps_Registry {
/**
* Registered sitemap providers.
*
* @since 5.5.0
*
* @var WP_Sitemaps_Provider[] Array of registered sitemap providers.
*/
private $providers = array();
/**
* Adds a new sitemap provider.
*
* @since 5.5.0
*
* @param string $name Name of the sitemap provider.
* @param WP_Sitemaps_Provider $provider Instance of a WP_Sitemaps_Provider.
* @return bool Whether the provider was added successfully.
*/
public function add_provider( $name, WP_Sitemaps_Provider $provider ) {
if ( isset( $this->providers[ $name ] ) ) {
return false;
}
/**
* Filters the sitemap provider before it is added.
*
* @since 5.5.0
*
* @param WP_Sitemaps_Provider $provider Instance of a WP_Sitemaps_Provider.
* @param string $name Name of the sitemap provider.
*/
$provider = apply_filters( 'wp_sitemaps_add_provider', $provider, $name );
if ( ! $provider instanceof WP_Sitemaps_Provider ) {
return false;
}
$this->providers[ $name ] = $provider;
return true;
}
/**
* Returns a single registered sitemap provider.
*
* @since 5.5.0
*
* @param string $name Sitemap provider name.
* @return WP_Sitemaps_Provider|null Sitemap provider if it exists, null otherwise.
*/
public function get_provider( $name ) {
if ( ! is_string( $name ) || ! isset( $this->providers[ $name ] ) ) {
return null;
}
return $this->providers[ $name ];
}
/**
* Returns all registered sitemap providers.
*
* @since 5.5.0
*
* @return WP_Sitemaps_Provider[] Array of sitemap providers.
*/
public function get_providers() {
return $this->providers;
}
}
Changelog
| Version | Description |
|---|---|
| 5.5.0 | Introduced. |