WP_Sitemaps_Index
云策文档标注
概述
WP_Sitemaps_Index 类用于构建站点地图索引页面，列出所有站点地图的链接。它管理站点地图提供者并生成索引URL。
关键要点
- WP_Sitemaps_Index 类负责生成站点地图索引，包含指向所有站点地图的链接。
- 类中定义了最大站点地图数量限制为50000，通过 get_sitemap_list 方法获取站点地图列表。
- 提供 get_index_url 方法根据是否使用固定链接来构建站点地图索引的URL。
- 构造函数接收 WP_Sitemaps_Registry 参数，用于注册和管理站点地图提供者。
代码示例
public function get_sitemap_list() {
$sitemaps = array();
$providers = $this->registry->get_providers();
/* @var WP_Sitemaps_Provider $provider */
foreach ( $providers as $name => $provider ) {
$sitemap_entries = $provider->get_sitemap_entries();
// Prevent issues with array_push and empty arrays on PHP < 7.4.
if ( ! $sitemap_entries ) {
continue;
}
foreach ( $sitemap_entries as $entry ) {
$sitemaps[] = array_merge( $entry, array( 'provider' => $name ) );
}
if ( count( $sitemaps ) >= $this->max_sitemaps ) {
break;
}
}
return array_slice( $sitemaps, 0, $this->max_sitemaps, true );
}
原文内容
Class WP_Sitemaps_Index.
Description
Builds the sitemap index page that lists the links to all of the sitemaps.
Methods
| Name | Description |
|---|---|
| WP_Sitemaps_Index::__construct | WP_Sitemaps_Index constructor. |
| WP_Sitemaps_Index::get_index_url | Builds the URL for the sitemap index. |
| WP_Sitemaps_Index::get_sitemap_list | Gets a sitemap list for the index. |
Source
class WP_Sitemaps_Index {
/**
* The main registry of supported sitemaps.
*
* @since 5.5.0
* @var WP_Sitemaps_Registry
*/
protected $registry;
/**
* Maximum number of sitemaps to include in an index.
*
* @since 5.5.0
*
* @var int Maximum number of sitemaps.
*/
private $max_sitemaps = 50000;
/**
* WP_Sitemaps_Index constructor.
*
* @since 5.5.0
*
* @param WP_Sitemaps_Registry $registry Sitemap provider registry.
*/
public function __construct( WP_Sitemaps_Registry $registry ) {
$this->registry = $registry;
}
/**
* Gets a sitemap list for the index.
*
* @since 5.5.0
*
* @return array[] Array of all sitemaps.
*/
public function get_sitemap_list() {
$sitemaps = array();
$providers = $this->registry->get_providers();
/* @var WP_Sitemaps_Provider $provider */
foreach ( $providers as $name => $provider ) {
$sitemap_entries = $provider->get_sitemap_entries();
// Prevent issues with array_push and empty arrays on PHP < 7.3.
if ( ! $sitemap_entries ) {
continue;
}
// Using array_push is more efficient than array_merge in a loop.
array_push( $sitemaps, ...$sitemap_entries );
if ( count( $sitemaps ) >= $this->max_sitemaps ) {
break;
}
}
return array_slice( $sitemaps, 0, $this->max_sitemaps, true );
}
/**
* Builds the URL for the sitemap index.
*
* @since 5.5.0
*
* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
*
* @return string The sitemap index URL.
*/
public function get_index_url() {
global $wp_rewrite;
if ( ! $wp_rewrite->using_permalinks() ) {
return home_url( '/?sitemap=index' );
}
return home_url( '/wp-sitemap.xml' );
}
}
Changelog
| Version | Description |
|---|---|
| 5.5.0 | Introduced. |