WP_Sitemaps_Provider::get_sitemap_entries(): array[]
- Since
- 5.5.0
- Source
wp-includes/sitemaps/class-wp-sitemaps-provider.php:106
Description
The returned data is used to populate the sitemap entries of the index.
Compatibility
- WordPress
- since 5.5.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.
Return value
array[]- Array of sitemap entries.
Performance profile
How much work a call to WP_Sitemaps_Provider::get_sitemap_entries() 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
- Light
- Scaling
- Scales with input
- Instructions
- 7–8
- Plugin surface
- 1 hook
- Called by
- 0
Touches nothing outside its own arguments.
The body loops, so the work grows with how much data it finds.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 37.
Third-party callbacks on 'wp_sitemaps_index_entry' 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
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Sitemaps_Provider::get_sitemap_entries() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 7–8 | ->get_sitemap_type_data() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 37 | 7–8 | 3 | |
| 8.5 | 37 | 7–8 | 3 | |
| 8.4 | 37 | 7–8 | 3 | |
| 8.3 | 37 | 7–8 | 3 | |
| 8.2 | 37 | 7–8 | 3 | 1 more instruction than PHP 8.1 |
| 8.1 | 36 | 7–13 | 3 | |
| 7.4 | 36 | 7–13 | 3 |
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_Provider::get_sitemap_entries() runs, in this order:
- apply_filters( wp_sitemaps_index_entry )filterline 128 (+22 into the body)
Filters the sitemap entry for the sitemap index.
Uses · 3
- apply_filters()Calls the callback functions that have been added to a filter hook.
- WP_Sitemaps_Provider::get_sitemap_type_data()Gets data about each sitemap type.
- WP_Sitemaps_Provider::get_sitemap_url()Gets the URL of a sitemap entry.
Source code
public function get_sitemap_entries() { $sitemaps = array(); $sitemap_types = $this->get_sitemap_type_data(); foreach ( $sitemap_types as $type ) { for ( $page = 1; $page <= $type['pages']; $page++ ) { $sitemap_entry = array( 'loc' => $this->get_sitemap_url( $type['name'], $page ), ); /** * Filters the sitemap entry for the sitemap index. * * @since 5.5.0 * * @param array $sitemap_entry Sitemap entry for the post. * @param string $object_type Object empty name. * @param string $object_subtype Object subtype name. * Empty string if the object type does not support subtypes. * @param int $page Page number of results. */ $sitemap_entry = apply_filters( 'wp_sitemaps_index_entry', $sitemap_entry, $this->object_type, $type['name'], $page ); $sitemaps[] = $sitemap_entry; } } return $sitemaps; }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.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/sitemaps/class-wp-sitemaps-provider.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.