W3cubDocs

/WordPress

WP_Sitemaps_Provider::get_sitemap_entries()

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

File: wp-includes/sitemaps/class-wp-sitemaps-provider.php 

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;
	}

Uses

Uses Description
wp-includes/sitemaps/class-wp-sitemaps-provider.php: WP_Sitemaps_Provider::get_sitemap_url()

Gets the URL of a sitemap entry.
wp-includes/sitemaps/class-wp-sitemaps-provider.php: wp_sitemaps_index_entry

Filters the sitemap entry for the sitemap index.
wp-includes/sitemaps/class-wp-sitemaps-provider.php: WP_Sitemaps_Provider::get_sitemap_type_data()

Gets data about each sitemap type.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.

Changelog

Version Description
5.5.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_sitemaps_provider/get_sitemap_entries