Main sitemap controller integrating all sitemap components.

Source: wp-includes/sitemaps/class-wp-sitemaps.php
Since: 5.5.0

Overview

The main class that orchestrates sitemap functionality including provider registration, rewrite rules, rendering, and robots.txt integration.

Properties

Methods

__construct()

Initializes sitemap components.

public function __construct()

Creates:

• WP_Sitemaps_Registry instance
• WP_Sitemaps_Renderer instance
• WP_Sitemaps_Index instance (with registry)

init()

Initiates all sitemap functionality.

public function init(): void

Actions:

• Registers rewrite rules (always, for proper 404 handling)
• Adds template_redirect action for rendering
• If sitemaps enabled:
  • Registers default providers
  • Adds sitemap to robots.txt

Note: Called automatically by wp_sitemaps_get_server().

sitemaps_enabled()

Determines whether sitemaps are enabled.

public function sitemaps_enabled(): bool

Returns: true if sitemaps are enabled.

Default: Enabled when blog_public option is true.

Hooks:

apply_filters( 'wp_sitemaps_enabled', bool $is_enabled )

Example:

// Disable sitemaps entirely
add_filter( 'wp_sitemaps_enabled', '__return_false' );

register_sitemaps()

Registers default sitemap providers.

public function register_sitemaps(): void

Registers:

• posts → WP_Sitemaps_Posts
• taxonomies → WP_Sitemaps_Taxonomies
• users → WP_Sitemaps_Users

register_rewrites()

Registers sitemap rewrite tags and routing rules.

public function register_rewrites(): void

Rewrite Tags:

• %sitemap% — Provider name
• %sitemap-subtype% — Object subtype
• %sitemap-stylesheet% — XSL stylesheet type

Rewrite Rules:

render_sitemaps()

Renders sitemap templates based on rewrite rules.

public function render_sitemaps(): void

Hooked to: template_redirect

Flow:

1. Check query vars (sitemap, sitemap-subtype, sitemap-stylesheet, paged)
2. If not sitemap request, return early
3. If sitemaps disabled, return 404
4. For stylesheet: render via WP_Sitemaps_Stylesheet
5. For index: render via WP_Sitemaps_Renderer::render_index()
6. For provider: get URLs and render via WP_Sitemaps_Renderer::render_sitemap()
7. If no URLs found, return 404

add_robots()

Adds the sitemap index to robots.txt.

public function add_robots( string $output, bool $is_public ): string

Hooked to: robots_txt filter (priority 0)

Returns: Modified robots.txt with sitemap URL.

Output:

Sitemap: https://example.com/wp-sitemap.xml

redirect_sitemapxml()

Redirects /sitemap-xml to /wp-sitemap.xml.

public function redirect_sitemapxml( bool $bypass, WP_Query $query ): bool

Deprecated: 6.7.0 — Use WP_Rewrite::rewrite_rules() instead.

Returns: Pass-through of bypass value.

Usage Example

// Get sitemap server
$sitemaps = wp_sitemaps_get_server();

// Access components
$providers = $sitemaps->registry->get_providers();
$index_url = $sitemaps->index->get_index_url();

// Check if enabled
if ( $sitemaps->sitemaps_enabled() ) {
    // Sitemaps are active
}