WordPress开发手册:get_sitemap_url()

函数原型

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

函数描述

是否弃用

未弃用

函数参数

$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

函数返回值

函数位置

函数源码

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

源码链接

WordPress
Github

变更日志