WP_Sitemaps_Posts::get_max_num_pages( string $object_subtype = '' ): int
- Since
- 5.5.0, 5.9.0
- Source
wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php:181
Compatibility
- WordPress
- since 5.9.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
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- Post type name. Default empty.Default:
''
Return value
int- Total number of pages.
Performance profile
How much work a call to WP_Sitemaps_Posts::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
- Moderate
- Scaling
- Constant
- Instructions
- 4–39
- Plugin surface
- 1 hook
- Called by
- 0
Reads stored settings via get_option(), cached per request but not free on a cold cache.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 43.
Third-party callbacks on 'wp_sitemaps_posts_pre_max_num_pages' run inside this call, and their cost is not bounded by anything here.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
apply_filters()called directly - optionoption read or write
get_option()called directly - cacheobject cache
wp_cache_get()one call below WP_Sitemaps_Posts::get_max_num_pages() - serializeserialisation
maybe_unserialize()one call below WP_Sitemaps_Posts::get_max_num_pages()
Further down the call graph this can also reach query 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 · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Sitemaps_Posts::get_max_num_pages() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
empty($object_subtype) | 4 | none |
!empty($object_subtype) && $max_num_pages !== null | 13 | apply_filters() |
!empty($object_subtype) && $max_num_pages === null && $post_type !== "page" | 31–33 | apply_filters(), ->get_posts_query_args() |
!empty($object_subtype) && $max_num_pages === null && $post_type === "page" | 36–39 | apply_filters(), ->get_posts_query_args(), get_option() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 43 | 4–39 | 5 | |
| 8.5 | 43 | 4–39 | 5 | |
| 8.4 | 43 | 4–39 | 5 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 46 | 4–42 | 5 | |
| 8.2 | 46 | 4–42 | 5 | |
| 8.1 | 46 | 4–42 | 5 | |
| 7.4 | 46 | 4–42 | 5 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while WP_Sitemaps_Posts::get_max_num_pages() runs, in this order:
- apply_filters( wp_sitemaps_posts_pre_max_num_pages )filterline 200 (+19 into the body)
Filters the max number of pages before it is generated.
Uses · 4
- apply_filters()Calls the callback functions that have been added to a filter hook.
- get_option()Retrieves an option value based on an option name.
- WP_Sitemaps_Posts::get_posts_query_args()Returns the query args for retrieving posts to list in the sitemap.
- WP_Query::__construct()Constructor.
Source code
public function get_max_num_pages( $object_subtype = '' ) { if ( empty( $object_subtype ) ) { return 0; } // Restores the more descriptive, specific name for use within this method. $post_type = $object_subtype; /** * 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; }Changelog
Introduced in 5.5.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$post_type to $object_subtype to match parent class for PHP 8 named parameter support.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 6.9.7 tag, from
src/wp-includes/sitemaps/providers/class-wp-sitemaps-posts.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.