WP_Sitemaps_Taxonomies::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

Taxonomy name. Default empty.Default: ''

Return value

int

Total number of pages.

Performance profile

How much work a call to WP_Sitemaps_Taxonomies::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

Heavy

Reaches the database via get_terms().

Scaling

Constant

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

Instructions

4–31

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

Plugin surface

1 hook

Third-party callbacks on 'wp_sitemaps_taxonomies_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
• querycontent queryget_terms()one call below WP_Sitemaps_Taxonomies::get_max_num_pages()

Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 3 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Sitemaps_Taxonomies::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_Taxonomies::get_max_num_pages() runs, in this order:

1. 1
   apply_filters( wp_sitemaps_taxonomies_pre_max_num_pages )filterline 166 (+19 into the body)

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

Uses · 4

• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_count_terms()Counts how many terms are in taxonomy.
• wp_sitemaps_get_max_urls()Gets the maximum number of URLs for a sitemap.
• WP_Sitemaps_Taxonomies::get_taxonomies_query_args()Returns the query args for retrieving taxonomy terms to list in the sitemap.

Source code

View on Trac ↗View on GitHub ↗

147	public function get_max_num_pages( $object_subtype = '' ) {148		if ( empty( $object_subtype ) ) {149			return 0;150		}151 152		// Restores the more descriptive, specific name for use within this method.153		$taxonomy = $object_subtype;154 155		/**156		 * Filters the max number of pages for a taxonomy sitemap before it is generated.157		 *158		 * Passing a non-null value will short-circuit the generation,159		 * returning that value instead.160		 *161		 * @since 5.5.0162		 *163		 * @param int|null $max_num_pages The maximum number of pages. Default null.164		 * @param string   $taxonomy      Taxonomy name.165		 */166		$max_num_pages = apply_filters( 'wp_sitemaps_taxonomies_pre_max_num_pages', null, $taxonomy );167 168		if ( null !== $max_num_pages ) {169			return $max_num_pages;170		}171 172		$term_count = wp_count_terms( $this->get_taxonomies_query_args( $taxonomy ) );173 174		return (int) ceil( (int) $term_count / wp_sitemaps_get_max_urls( $this->object_type ) );175	}

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.0.4 tag, from src/wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.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.