get_sitemap_url( string $name, string $subtype_name = '', int $page = 1 ): string|false

Retrieves the full URL for a sitemap.


Parameters

$name string Required
The sitemap name.
$subtype_name string Optional
The sitemap subtype name.

Default: ''

$page int Optional
The page of the sitemap.

Default: 1


Top ↑

Return

string|false The sitemap URL or false if the sitemap doesn't exist.


Top ↑

Source

File: wp-includes/sitemaps.php. View all references

function get_sitemap_url( $name, $subtype_name = '', $page = 1 ) {
	$sitemaps = wp_sitemaps_get_server();

	if ( ! $sitemaps ) {
		return false;
	}

	if ( 'index' === $name ) {
		return $sitemaps->index->get_index_url();
	}

	$provider = $sitemaps->registry->get_provider( $name );
	if ( ! $provider ) {
		return false;
	}

	if ( $subtype_name && ! in_array( $subtype_name, array_keys( $provider->get_object_subtypes() ), true ) ) {
		return false;
	}

	$page = absint( $page );
	if ( 0 >= $page ) {
		$page = 1;
	}

	return $provider->get_sitemap_url( $subtype_name, $page );
}


Top ↑

Changelog

Changelog
Version Description
5.5.1 Introduced.

Top ↑

User Contributed Notes

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