W3cubDocs

/WordPress

WP_Sitemaps_Taxonomies::get_url_list( int $page_num, string $taxonomy = '' )

Gets a URL list for a taxonomy sitemap.

Parameters

$page_num

(int) (Required) Page of results.

$taxonomy

(string) (Optional) Taxonomy name.

Default value: ''

Return

(array) Array of URLs for a sitemap.

Source

File: wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.php 

public function get_url_list( $page_num, $taxonomy = '' ) {
		$supported_types = $this->get_object_subtypes();

		// Bail early if the queried taxonomy is not supported.
		if ( ! isset( $supported_types[ $taxonomy ] ) ) {
			return array();
		}

		/**
		 * Filters the taxonomies URL list before it is generated.
		 *
		 * Passing a non-null value will effectively short-circuit the generation,
		 * returning that value instead.
		 *
		 * @since 5.5.0
		 *
		 * @param array  $url_list The URL list. Default null.
		 * @param string $taxonomy Taxonomy name.
		 * @param int    $page_num Page of results.
		 */
		$url_list = apply_filters(
			'wp_sitemaps_taxonomies_pre_url_list',
			null,
			$taxonomy,
			$page_num
		);

		if ( null !== $url_list ) {
			return $url_list;
		}

		$url_list = array();

		// Offset by how many terms should be included in previous pages.
		$offset = ( $page_num - 1 ) * wp_sitemaps_get_max_urls( $this->object_type );

		$args           = $this->get_taxonomies_query_args( $taxonomy );
		$args['offset'] = $offset;

		$taxonomy_terms = new WP_Term_Query( $args );

		if ( ! empty( $taxonomy_terms->terms ) ) {
			foreach ( $taxonomy_terms->terms as $term ) {
				$sitemap_entry = array(
					'loc' => get_term_link( $term ),
				);

				/**
				 * Filters the sitemap entry for an individual term.
				 *
				 * @since 5.5.0
				 *
				 * @param array   $sitemap_entry Sitemap entry for the term.
				 * @param WP_Term $term          Term object.
				 * @param string  $taxonomy      Taxonomy name.
				 */
				$sitemap_entry = apply_filters( 'wp_sitemaps_taxonomies_entry', $sitemap_entry, $term, $taxonomy );
				$url_list[]    = $sitemap_entry;
			}
		}

		return $url_list;
	}

Uses

Uses Description
wp-includes/sitemaps.php: wp_sitemaps_get_max_urls()

Gets the maximum number of URLs for a sitemap.
wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.php: WP_Sitemaps_Taxonomies::get_object_subtypes()

Returns all public, registered taxonomies.
wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.php: WP_Sitemaps_Taxonomies::get_taxonomies_query_args()

Returns the query args for retrieving taxonomy terms to list in the sitemap.
wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.php: wp_sitemaps_taxonomies_pre_url_list

Filters the taxonomies URL list before it is generated.
wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.php: wp_sitemaps_taxonomies_entry

Filters the sitemap entry for an individual term.
wp-includes/class-wp-term-query.php: WP_Term_Query::__construct()

Constructor.
wp-includes/taxonomy.php: get_term_link()

Generate a permalink for a taxonomy term archive.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.

Changelog

Version Description
5.5.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_sitemaps_taxonomies/get_url_list