wppaste
WordPress

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

Since
5.5.0
Source
wp-includes/sitemaps/providers/class-wp-sitemaps-users.php:100
Gets the max number of pages available for the object type.

Parameters

$object_subtypestringoptional
Not applicable for Users but required for compatibility with the parent provider class. Default empty.Default: ''

Return

int
Total page count.

Hooks fired · 1

One hook fires while WP_Sitemaps_Users::get_max_num_pages() runs, in this order:

  1. apply_filters( wp_sitemaps_users_pre_max_num_pages )filterline 111 (+11 into the body)

    Filters the max number of pages for a user sitemap before it is generated.

Uses · 4

Source

	public function get_max_num_pages( $object_subtype = '' ) {		/**		 * Filters the max number of pages for a user sitemap before it is generated.		 *		 * Returning a non-null value will effectively 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.		 */		$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 ) );	}

History

Introduced in 5.5.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/sitemaps/providers/class-wp-sitemaps-users.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.