W3cubDocs

/WordPress

WP_Sitemaps_Users::get_max_num_pages( string $object_subtype = '' )

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

Description

Parameters

$object_subtype

(string) (Optional) Not applicable for Users but required for compatibility with the parent provider class.

Default value: ''

Return

(int) Total page count.

Source

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

public function get_max_num_pages( $object_subtype = '' ) {
		/**
		 * Filters the max number of pages before it is generated.
		 *
		 * Passing a non-null value will effectively short-circuit the generation,
		 * returning that value instead.
		 *
		 * @since 5.5.0
		 *
		 * @param int $max_num_pages The maximum number of pages. Default null.
		 */
		$max_num_pages = apply_filters( 'wp_sitemaps_users_pre_max_num_pages', null );

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

		$args  = $this->get_users_query_args();
		$query = new WP_User_Query( $args );

		$total_users = $query->get_total();

		return (int) ceil( $total_users / wp_sitemaps_get_max_urls( $this->object_type ) );
	}

Uses

Uses	Description
wp-includes/sitemaps.php: wp_sitemaps_get_max_urls()	Gets the maximum number of URLs for a sitemap.
wp-includes/sitemaps/providers/class-wp-sitemaps-users.php: WP_Sitemaps_Users::get_users_query_args()	Returns the query args for retrieving users to list in the sitemap.
wp-includes/sitemaps/providers/class-wp-sitemaps-users.php: wp_sitemaps_users_pre_max_num_pages	Filters the max number of pages before it is generated.
wp-includes/plugin.php: apply_filters()	Calls the callback functions that have been added to a filter hook.
wp-includes/class-wp-user-query.php: WP_User_Query::__construct()	PHP5 constructor.

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_users/get_max_num_pages