WP_Sitemaps_Stylesheet::get_sitemap_stylesheet()

Compatibility

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

Performance profile

How much work a call to WP_Sitemaps_Stylesheet::get_sitemap_stylesheet() 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

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

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

Instructions

105

Executed per call on PHP 8.5. The body compiles to 105.

Plugin surface

1 hook

Third-party callbacks on 'wp_sitemaps_stylesheet_content' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()one call below WP_Sitemaps_Stylesheet::get_sitemap_stylesheet()

Further down the call graph this can also reach 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 · 1 distinct outcome

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

Hooks and filters fired · 1

One hook fires while WP_Sitemaps_Stylesheet::get_sitemap_stylesheet() runs, in this order:

1. 1
   apply_filters( wp_sitemaps_stylesheet_content )filterline 151 (+106 into the body)

   Filters the content of the sitemap stylesheet.

Uses · 6

• esc_xml()Escaping for XML blocks.
• __()Retrieves the translation of $text.
• esc_url()Checks and cleans a URL.
• get_language_attributes()Gets the language attributes for the 'html' tag.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_Sitemaps_Stylesheet::get_stylesheet_css()Gets the CSS to be included in sitemap XSL stylesheets.

Used by · 1

• WP_Sitemaps_Stylesheet::render_stylesheet()Renders the XSL stylesheet depending on whether it's the sitemap index or not.

Source code

View on Trac ↗View on GitHub ↗

45	public function get_sitemap_stylesheet() {46		$css         = $this->get_stylesheet_css();47		$title       = esc_xml( __( 'XML Sitemap' ) );48		$description = esc_xml( __( 'This XML Sitemap is generated by WordPress to make your content more visible for search engines.' ) );49		$learn_more  = sprintf(50			'<a href="%s">%s</a>',51			esc_url( __( 'https://www.sitemaps.org/' ) ),52			esc_xml( __( 'Learn more about XML sitemaps.' ) )53		);54 55		$text = sprintf(56			/* translators: %s: Number of URLs. */57			esc_xml( __( 'Number of URLs in this XML Sitemap: %s.' ) ),58			'<xsl:value-of select="count( sitemap:urlset/sitemap:url )" />'59		);60 61		$lang       = get_language_attributes( 'html' );62		$url        = esc_xml( __( 'URL' ) );63		$lastmod    = esc_xml( __( 'Last Modified' ) );64		$changefreq = esc_xml( __( 'Change Frequency' ) );65		$priority   = esc_xml( __( 'Priority' ) );66 67		$xsl_content = <<<XSL68<?xml version="1.0" encoding="UTF-8"?>69<xsl:stylesheet70		version="1.0"71		xmlns:xsl="http://www.w3.org/1999/XSL/Transform"72		xmlns:sitemap="http://www.sitemaps.org/schemas/sitemap/0.9"73		exclude-result-prefixes="sitemap"74		>75 76	<xsl:output method="html" encoding="UTF-8" indent="yes" />77 78	<!--79	  Set variables for whether lastmod, changefreq or priority occur for any url in the sitemap.80	  We do this up front because it can be expensive in a large sitemap.81	  -->82	<xsl:variable name="has-lastmod"    select="count( /sitemap:urlset/sitemap:url/sitemap:lastmod )"    />83	<xsl:variable name="has-changefreq" select="count( /sitemap:urlset/sitemap:url/sitemap:changefreq )" />84	<xsl:variable name="has-priority"   select="count( /sitemap:urlset/sitemap:url/sitemap:priority )"   />85 86	<xsl:template match="/">87		<html {$lang}>88			<head>89				<title>{$title}</title>90				<style>91					{$css}92				</style>93			</head>94			<body>95				<div id="sitemap">96					<div id="sitemap__header">97						<h1>{$title}</h1>98						<p>{$description}</p>99						<p>{$learn_more}</p>100					</div>101					<div id="sitemap__content">102						<p class="text">{$text}</p>103						<table id="sitemap__table">104							<thead>105								<tr>106									<th class="loc">{$url}</th>107									<xsl:if test="\$has-lastmod">108										<th class="lastmod">{$lastmod}</th>109									</xsl:if>110									<xsl:if test="\$has-changefreq">111										<th class="changefreq">{$changefreq}</th>112									</xsl:if>113									<xsl:if test="\$has-priority">114										<th class="priority">{$priority}</th>115									</xsl:if>116								</tr>117							</thead>118							<tbody>119								<xsl:for-each select="sitemap:urlset/sitemap:url">120									<tr>121										<td class="loc"><a href="{sitemap:loc}"><xsl:value-of select="sitemap:loc" /></a></td>122										<xsl:if test="\$has-lastmod">123											<td class="lastmod"><xsl:value-of select="sitemap:lastmod" /></td>124										</xsl:if>

Changelog

Introduced in 5.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

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

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/sitemaps/class-wp-sitemaps-stylesheet.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.