[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/ -> sitemaps.php (summary)

Sitemaps: Public functions This file contains a variety of public functions developers can use to interact with the XML Sitemaps API.

File Size: 125 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 5 functions

  wp_sitemaps_get_server()
  wp_get_sitemap_providers()
  wp_register_sitemap_provider()
  wp_sitemaps_get_max_urls()
  get_sitemap_url()

Functions
Functions that are not part of a class:

wp_sitemaps_get_server()   X-Ref
Retrieves the current Sitemaps server instance.

return: WP_Sitemaps Sitemaps instance.

wp_get_sitemap_providers()   X-Ref
Gets an array of sitemap providers.

return: WP_Sitemaps_Provider[] Array of sitemap providers.

wp_register_sitemap_provider( $name, WP_Sitemaps_Provider $provider )   X-Ref
Registers a new sitemap provider.

return: bool Whether the sitemap was added.
param: string               $name     Unique name for the sitemap provider.
param: WP_Sitemaps_Provider $provider The `Sitemaps_Provider` instance implementing the sitemap.

wp_sitemaps_get_max_urls( $object_type )   X-Ref
Gets the maximum number of URLs for a sitemap.

return: int The maximum number of URLs.
param: string $object_type Object type for sitemap to be filtered (e.g. 'post', 'term', 'user').

get_sitemap_url( $name, $subtype_name = '', $page = 1 )   X-Ref
Retrieves the full URL for a sitemap.

return: string|false The sitemap URL or false if the sitemap doesn't exist.
param: string $name         The sitemap name.
param: string $subtype_name The sitemap subtype name.  Default empty string.
param: int    $page         The page of the sitemap.  Default 1.



Generated : Mon Oct 26 08:20:01 2020 Cross-referenced by PHPXref