WP_Sitemaps::render_sitemaps()

Compatibility

Present in every tracked release (6.7.10 to 7.1.3), and compiles on PHP 7.4 through 8.6-dev.

Performance profile

How much work a call to WP_Sitemaps::render_sitemaps() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

9–87

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 103.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()one call below WP_Sitemaps::render_sitemaps()

Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 29 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Sitemaps::render_sitemaps() can have, taken from its control-flow graph on PHP 8.5.

Uses · 6

• get_query_var()Retrieves the value of a query variable in the WP_Query class.
• sanitize_text_field()Sanitizes a string from user input or from the database.
• absint()Converts a value to non-negative integer.
• WP_Sitemaps::send_404()Sends a 404 for a sitemap route that cannot be served.
• WP_Sitemaps::sitemaps_enabled()Determines whether sitemaps are enabled or not.
• WP_Sitemaps_Stylesheet::__construct()

Source code

View on Trac ↗View on GitHub ↗

161	public function render_sitemaps() {162		/*163		 * Bail early if this isn't a sitemap or stylesheet route.164		 *165		 * This runs on every front-end request, so it comes before any166		 * sanitizing. The raw query vars are tested here, matching167		 * WP::handle_404(), which exempts sitemap requests from its own 404 on168		 * the same basis. Testing the sanitized values instead would let a169		 * request that handle_404() exempted fall through both, leaving it a 200.170		 */171		if ( ! get_query_var( 'sitemap' ) && ! get_query_var( 'sitemap-stylesheet' ) ) {172			return;173		}174 175		$sitemap         = sanitize_text_field( get_query_var( 'sitemap' ) );176		$object_subtype  = sanitize_text_field( get_query_var( 'sitemap-subtype' ) );177		$stylesheet_type = sanitize_text_field( get_query_var( 'sitemap-stylesheet' ) );178		$paged           = absint( get_query_var( 'paged' ) );179 180		// Force a 404 and bail early if the route did not survive sanitizing.181		if ( ! ( $sitemap || $stylesheet_type ) ) {182			$this->send_404();183			return;184		}185 186		if ( ! $this->sitemaps_enabled() ) {187			$this->send_404();188			return;189		}190 191		// Render stylesheet if this is stylesheet route.192		if ( $stylesheet_type ) {193			// Force a 404 and bail early if the stylesheet type is not recognized.194			if ( ! in_array( $stylesheet_type, array( 'sitemap', 'index' ), true ) ) {195				$this->send_404();196				return;197			}198 199			$stylesheet = new WP_Sitemaps_Stylesheet();200 201			$stylesheet->render_stylesheet( $stylesheet_type );202			exit;203		}204 205		// Render the index.206		if ( 'index' === $sitemap ) {207			$sitemap_list = $this->index->get_sitemap_list();208 209			$this->renderer->render_index( $sitemap_list );210			exit;211		}212 213		$provider = $this->registry->get_provider( $sitemap );214 215		// Force a 404 and bail early if the requested provider is not registered.216		if ( ! $provider ) {217			$this->send_404();218			return;219		}220 221		if ( empty( $paged ) ) {222			$paged = 1;223		}224 225		$url_list = $provider->get_url_list( $paged, $object_subtype );226 227		// Force a 404 and bail early if no URLs are present.228		if ( empty( $url_list ) ) {229			$this->send_404();230			return;231		}232 233		$this->renderer->render_sitemap( $url_list );234		exit;235	}

Changelog

Introduced in 5.5.0. Unchanged from 6.7.10 through 7.1.3.

1. 6.7.10
2. 6.8.11
3. 6.9.10
4. 7.0.7
5. 7.1.3

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.3 tag, from src/wp-includes/sitemaps/class-wp-sitemaps.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.