[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

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

Sitemaps: WP_Sitemaps_Provider class This class is a base class for other sitemap providers to extend and contains shared functionality.

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

Defines 4 functions

  get_sitemap_type_data()
  get_sitemap_entries()
  get_sitemap_url()
  get_object_subtypes()

Functions
Functions that are not part of a class:

get_sitemap_type_data()   X-Ref
Gets data about each sitemap type.

return: array[] Array of sitemap types including object subtype name and number of pages.
since: 5.5.0

get_sitemap_entries()   X-Ref
Lists sitemap pages exposed by this provider.

The returned data is used to populate the sitemap entries of the index.

return: array[] Array of sitemap entries.
since: 5.5.0

get_sitemap_url( $name, $page )   X-Ref
Gets the URL of a sitemap entry.

return: string The composed URL for a sitemap entry.
param: string $name The name of the sitemap.
param: int    $page The page of the sitemap.
since: 5.5.0

get_object_subtypes()   X-Ref
Returns the list of supported object subtypes exposed by the provider.

return: array List of object subtypes objects keyed by their name.
since: 5.5.0



Generated: Wed Sep 22 01:00:04 2021 Cross-referenced by PHPXref 0.7.1