WP_Sitemaps_Taxonomies::get_url_list( int $page_num, string $object_subtype = '' ): array[]

Compatibility

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

Parameters

$page_numint

Page of results.

$object_subtypestringoptional

Taxonomy name. Default empty.Default: ''

Return value

array[]

Array of URL information for a sitemap.

Performance profile

How much work a call to WP_Sitemaps_Taxonomies::get_url_list() 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_term().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

9–44

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

Plugin surface

2 hooks

Third-party callbacks on 'wp_sitemaps_taxonomies_pre_url_list', 'wp_sitemaps_taxonomies_entry' 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_term()one call below WP_Sitemaps_Taxonomies::get_url_list()

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_url_list() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while WP_Sitemaps_Taxonomies::get_url_list() runs, in this order:

1. 1
   apply_filters( wp_sitemaps_taxonomies_pre_url_list )filterline 84 (+23 into the body)

   Filters the taxonomies URL list before it is generated.

2. 2
   apply_filters( wp_sitemaps_taxonomies_entry )filterline 129 (+68 into the body)

   Filters the sitemap entry for an individual term.

Uses · 7

• 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.
• get_term_link()Generates a permalink for a taxonomy term archive.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• WP_Sitemaps_Taxonomies::get_object_subtypes()Returns all public, registered taxonomies.
• WP_Sitemaps_Taxonomies::get_taxonomies_query_args()Returns the query args for retrieving taxonomy terms to list in the sitemap.
• WP_Term_Query::__construct()Constructor.

Source code

View on Trac ↗View on GitHub ↗

61	public function get_url_list( $page_num, $object_subtype = '' ) {62		// Restores the more descriptive, specific name for use within this method.63		$taxonomy = $object_subtype;64 65		$supported_types = $this->get_object_subtypes();66 67		// Bail early if the queried taxonomy is not supported.68		if ( ! isset( $supported_types[ $taxonomy ] ) ) {69			return array();70		}71 72		/**73		 * Filters the taxonomies URL list before it is generated.74		 *75		 * Returning a non-null value will effectively short-circuit the generation,76		 * returning that value instead.77		 *78		 * @since 5.5.079		 *80		 * @param array[]|null $url_list The URL list. Default null.81		 * @param string       $taxonomy Taxonomy name.82		 * @param int          $page_num Page of results.83		 */84		$url_list = apply_filters(85			'wp_sitemaps_taxonomies_pre_url_list',86			null,87			$taxonomy,88			$page_num89		);90 91		if ( null !== $url_list ) {92			return $url_list;93		}94 95		$url_list = array();96 97		// Offset by how many terms should be included in previous pages.98		$offset = ( $page_num - 1 ) * wp_sitemaps_get_max_urls( $this->object_type );99 100		$args           = $this->get_taxonomies_query_args( $taxonomy );101		$args['fields'] = 'all';102		$args['offset'] = $offset;103 104		$taxonomy_terms = new WP_Term_Query( $args );105 106		if ( ! empty( $taxonomy_terms->terms ) ) {107			foreach ( $taxonomy_terms->terms as $term ) {108				$term_link = get_term_link( $term, $taxonomy );109 110				if ( is_wp_error( $term_link ) ) {111					continue;112				}113 114				$sitemap_entry = array(115					'loc' => $term_link,116				);117 118				/**119				 * Filters the sitemap entry for an individual term.120				 *121				 * @since 5.5.0122				 * @since 6.0.0 Added `$term` argument containing the term object.123				 *124				 * @param array   $sitemap_entry Sitemap entry for the term.125				 * @param int     $term_id       Term ID.126				 * @param string  $taxonomy      Taxonomy name.127				 * @param WP_Term $term          Term object.128				 */129				$sitemap_entry = apply_filters( 'wp_sitemaps_taxonomies_entry', $sitemap_entry, $term->term_id, $taxonomy, $term );130				$url_list[]    = $sitemap_entry;131			}132		}133 134		return $url_list;135	}

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