W3cubDocs

/WordPress

WP_Sitemaps_Posts::get_max_num_pages( string $post_type = '' )

Gets the max number of pages available for the object type.

Parameters

$post_type

(string) (Optional) Post type name.

Default value: ''

Return

(int) Total number of pages.

Source

File: wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php 

public function get_max_num_pages( $post_type = '' ) {
		if ( empty( $post_type ) ) {
			return 0;
		}

		/**
		 * Filters the max number of pages before it is generated.
		 *
		 * Passing a non-null value will short-circuit the generation,
		 * returning that value instead.
		 *
		 * @since 5.5.0
		 *
		 * @param int|null $max_num_pages The maximum number of pages. Default null.
		 * @param string   $post_type     Post type name.
		 */
		$max_num_pages = apply_filters( 'wp_sitemaps_posts_pre_max_num_pages', null, $post_type );

		if ( null !== $max_num_pages ) {
			return $max_num_pages;
		}

		$args                  = $this->get_posts_query_args( $post_type );
		$args['fields']        = 'ids';
		$args['no_found_rows'] = false;

		$query = new WP_Query( $args );

		$min_num_pages = ( 'page' === $post_type && 'posts' === get_option( 'show_on_front' ) ) ? 1 : 0;
		return isset( $query->max_num_pages ) ? max( $min_num_pages, $query->max_num_pages ) : 1;
	}

Uses

Uses Description
wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php: WP_Sitemaps_Posts::get_posts_query_args()

Returns the query args for retrieving posts to list in the sitemap.
wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php: wp_sitemaps_posts_pre_max_num_pages

Filters the max number of pages before it is generated.
wp-includes/class-wp-query.php: WP_Query::__construct()

Constructor.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.

Changelog

Version Description
5.5.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_sitemaps_posts/get_max_num_pages