[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

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

Sitemaps: WP_Sitemaps_Posts class Builds the sitemaps for the 'post' object type.

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

Defines 1 class

WP_Sitemaps_Posts:: (5 methods):
  __construct()
  get_object_subtypes()
  get_url_list()
  get_max_num_pages()
  get_posts_query_args()


Class: WP_Sitemaps_Posts  - X-Ref

Posts XML sitemap provider.

__construct()   X-Ref
WP_Sitemaps_Posts constructor.

since: 5.5.0

get_object_subtypes()   X-Ref
Returns the public post types, which excludes nav_items and similar types.
Attachments are also excluded. This includes custom post types with public = true.

since: 5.5.0
return: WP_Post_Type[] Array of registered post type objects keyed by their name.

get_url_list( $page_num, $object_subtype = '' )   X-Ref
Gets a URL list for a post type sitemap.

since: 5.5.0
since: 5.9.0 Renamed `$post_type` to `$object_subtype` to match parent class
return: array Array of URLs for a sitemap.
param: int    $page_num       Page of results.
param: string $object_subtype Optional. Post type name. Default empty.

get_max_num_pages( $object_subtype = '' )   X-Ref
Gets the max number of pages available for the object type.

since: 5.5.0
since: 5.9.0 Renamed `$post_type` to `$object_subtype` to match parent class
return: int Total number of pages.
param: string $object_subtype Optional. Post type name. Default empty.

get_posts_query_args( $post_type )   X-Ref
Returns the query args for retrieving posts to list in the sitemap.

since: 5.5.0
return: array Array of WP_Query arguments.
param: string $post_type Post type name.



Generated: Tue Sep 21 01:00:05 2021 Cross-referenced by PHPXref 0.7.1