Title: get_sitemap_url
Published: September 16, 2020
Last modified: August 20, 2026

---

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

## In this article

 * [Parameters](https://developer.wordpress.org/reference/functions/get_sitemap_url/?output_format=md#parameters)
 * [Return](https://developer.wordpress.org/reference/functions/get_sitemap_url/?output_format=md#return)
 * [Source](https://developer.wordpress.org/reference/functions/get_sitemap_url/?output_format=md#source)
 * [Related](https://developer.wordpress.org/reference/functions/get_sitemap_url/?output_format=md#related)
 * [Changelog](https://developer.wordpress.org/reference/functions/get_sitemap_url/?output_format=md#changelog)

Retrieves the full URL for a sitemap.

## 󠀁[Parameters](https://developer.wordpress.org/reference/functions/get_sitemap_url/?output_format=md#parameters)󠁿

 `$name`stringrequired

The sitemap name.

`$subtype_name`stringoptional

The sitemap subtype name.

Default:`''`

`$page`intoptional

The page of the sitemap.

Default:`1`

## 󠀁[Return](https://developer.wordpress.org/reference/functions/get_sitemap_url/?output_format=md#return)󠁿

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

## 󠀁[Source](https://developer.wordpress.org/reference/functions/get_sitemap_url/?output_format=md#source)󠁿

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

[View all references](https://developer.wordpress.org/reference/files/wp-includes/sitemaps.php/)
[View on Trac](https://core.trac.wordpress.org/browser/tags/7.1/src/wp-includes/sitemaps.php#L103)
[View on GitHub](https://github.com/WordPress/wordpress-develop/blob/7.1/src/wp-includes/sitemaps.php#L103-L129)

## 󠀁[Related](https://developer.wordpress.org/reference/functions/get_sitemap_url/?output_format=md#related)󠁿

| Uses | Description | 
| [wp_sitemaps_get_server()](https://developer.wordpress.org/reference/functions/wp_sitemaps_get_server/)`wp-includes/sitemaps.php` |

Retrieves the current Sitemaps server instance.

  | 
| [absint()](https://developer.wordpress.org/reference/functions/absint/)`wp-includes/load.php` |

Converts a value to non-negative integer.

  |

| Used by | Description | 
| [redirect_canonical()](https://developer.wordpress.org/reference/functions/redirect_canonical/)`wp-includes/canonical.php` |

Redirects incoming links to the proper URL based on the site url.

  |

## 󠀁[Changelog](https://developer.wordpress.org/reference/functions/get_sitemap_url/?output_format=md#changelog)󠁿

| Version | Description | 
| [5.5.1](https://developer.wordpress.org/reference/since/5.5.1/) | Introduced. |

## User Contributed Notes

You must [log in](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Ffunctions%2Fget_sitemap_url%2F)
before being able to contribute a note or feedback.