WP_Sitemaps::sitemaps_enabled(): bool

Compatibility

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

Return value

bool

Whether sitemaps are enabled.

Performance profile

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

10

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

Plugin surface

1 hook

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

Called by

2

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

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_get()one call below WP_Sitemaps::sitemaps_enabled()
• serializeserialisationmaybe_unserialize()one call below WP_Sitemaps::sitemaps_enabled()

Further down the call graph this can also reach 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::sitemaps_enabled() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while WP_Sitemaps::sitemaps_enabled() runs, in this order:

1. 1
   apply_filters( wp_sitemaps_enabled )filterline 104 (+16 into the body)

   Filters whether XML Sitemaps are enabled or not.

Uses · 2

• get_option()Retrieves an option value based on an option name.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 2

• WP_Sitemaps::init()Initiates all sitemap functionality.
• WP_Sitemaps::render_sitemaps()Renders sitemap templates based on rewrite rules.

Source code

View on Trac ↗View on GitHub ↗

88	public function sitemaps_enabled() {89		$is_enabled = (bool) get_option( 'blog_public' );90 91		/**92		 * Filters whether XML Sitemaps are enabled or not.93		 *94		 * When XML Sitemaps are disabled via this filter, rewrite rules are still95		 * in place to ensure a 404 is returned.96		 *97		 * @see WP_Sitemaps::register_rewrites()98		 *99		 * @since 5.5.0100		 *101		 * @param bool $is_enabled Whether XML Sitemaps are enabled or not.102		 *                         Defaults to true for public sites.103		 */104		return (bool) apply_filters( 'wp_sitemaps_enabled', $is_enabled );105	}

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 7.0.4 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.