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

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$object_subtypestringoptional

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

Return value

int

Total page count.

Performance profile

How much work a call to WP_Sitemaps_Users::get_max_num_pages() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

9–29

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 30.

Plugin surface

1 hook

Third-party callbacks on 'wp_sitemaps_users_pre_max_num_pages' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Sitemaps_Users::get_max_num_pages() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

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

1. 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

• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_sitemaps_get_max_urls()Gets the maximum number of URLs for a sitemap.
• WP_Sitemaps_Users::get_users_query_args()Returns the query args for retrieving users to list in the sitemap.
• WP_User_Query::__construct()Constructor.

Source code

View on Trac ↗View on GitHub ↗

100	public function get_max_num_pages( $object_subtype = '' ) {101		/**102		 * Filters the max number of pages for a user sitemap before it is generated.103		 *104		 * Returning a non-null value will effectively short-circuit the generation,105		 * returning that value instead.106		 *107		 * @since 5.5.0108		 *109		 * @param int|null $max_num_pages The maximum number of pages. Default null.110		 */111		$max_num_pages = apply_filters( 'wp_sitemaps_users_pre_max_num_pages', null );112 113		if ( null !== $max_num_pages ) {114			return $max_num_pages;115		}116 117		$args  = $this->get_users_query_args();118		$query = new WP_User_Query( $args );119 120		$total_users = $query->get_total();121 122		return (int) ceil( $total_users / wp_sitemaps_get_max_urls( $this->object_type ) );123	}

Changelog

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.