get_sitemap_url()

最后更新于:2021-11-27 00:16:39

get_sitemap_url( string$name, string$subtype_name=”, int$page=1)

Retrieves the full URL for a sitemap.

参数

$name

(string) (Required) The sitemap name.

$subtype_name

(string) (Optional) The sitemap subtype name.

Default value: ”

$page

(int) (Optional) The page of the sitemap.

Default value: 1

响应

(string|false) The sitemap URL or false if the sitemap doesn’t exist.

源文件

文件: gc-includes/sitemaps.php

function get_sitemap_url( $name, $subtype_name = '', $page = 1 ) {
	$sitemaps = gc_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 );
}