WordPress filter hook · part of WordPress core

wp_sitemaps_index_entry

A WordPress core filter that 3 plugins also fire themselves, running on 100K+ sites between them.

“Filters the sitemap entry for the sitemap index.”

How to use wp_sitemaps_index_entry

It's a filter: your callback receives the value and 3 more arguments, and must return the (changed) value. Add this to your theme's functions.php or a small custom plugin:

functions.php
add_filter( 'wp_sitemaps_index_entry', function( $sitemap_entry, $object_type, $arg3, $page ) {
	// Change $sitemap_entry here.
	return $sitemap_entry;
}, 10, 4 );

Argument names come from XML Sitemap & Google News's source. Other plugins may pass different values: check the call in the plugin you're targeting below.

This hook is fired by WordPress core too. Official reference on developer.wordpress.org →

3 plugins that fire wp_sitemaps_index_entry

Sorted by active installs. Each entry shows where the plugin calls the hook and what it passes.

  1. XML Sitemap & Google News icon XML Sitemap & Google News100,000+ installs apply_filters( 'wp_sitemaps_index_entry', $sitemap_entry, $this->object_type, '', $page ) inc/class-sitemaps-provider-external.php:105
  2. GoDAM icon GoDAM100+ installs apply_filters( 'wp_sitemaps_index_entry', $entry, $this->object_type, '', $item['page'] ) inc/classes/class-video-sitemap-core-provider.php:73
  3. Gofer SEO icon Gofer SEOFewer than 10 installs apply_filters( 'wp_sitemaps_index_entry', $sitemap_entry, $this->object_type, $type['name'], $page ) includes/compatibility/wp/sitemaps/providers/class-wp-sitemaps-provider.php:131

Need a customisation built on this hook?

Tell us what you want to change and which plugin it's for. We'll write it, test it and send it back as a small plugin.