WP_Sitemaps_Provider::get_sitemap_entries(): array[]

In this article

Lists sitemap pages exposed by this provider.

Description

The returned data is used to populate the sitemap entries of the index.

Return

array[] Array of sitemap entries.

Source

public function get_sitemap_entries() {
	$sitemaps = array();

	$sitemap_types = $this->get_sitemap_type_data();

	foreach ( $sitemap_types as $type ) {
		for ( $page = 1; $page <= $type['pages']; $page++ ) {
			$sitemap_entry = array(
				'loc' => $this->get_sitemap_url( $type['name'], $page ),
			);

			/**
			 * Filters the sitemap entry for the sitemap index.
			 *
			 * @since 5.5.0
			 *
			 * @param array  $sitemap_entry  Sitemap entry for the post.
			 * @param string $object_type    Object empty name.
			 * @param string $object_subtype Object subtype name.
			 *                               Empty string if the object type does not support subtypes.
			 * @param int    $page           Page number of results.
			 */
			$sitemap_entry = apply_filters( 'wp_sitemaps_index_entry', $sitemap_entry, $this->object_type, $type['name'], $page );

			$sitemaps[] = $sitemap_entry;
		}
	}

	return $sitemaps;
}

Hooks

apply_filters( ‘wp_sitemaps_index_entry’, array $sitemap_entry, string $object_type, string $object_subtype, int $page )

Filters the sitemap entry for the sitemap index.

Changelog

VersionDescription
5.5.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.