Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Sitemaps: WP_Sitemaps_Taxonomies class

[2] Fix | Delete

[3] Fix | Delete

* Builds the sitemaps for the 'taxonomy' object type.

[4] Fix | Delete

[5] Fix | Delete

* @package WordPress

[6] Fix | Delete

* @subpackage Sitemaps

[7] Fix | Delete

* @since 5.5.0

[8] Fix | Delete

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Taxonomies XML sitemap provider.

[12] Fix | Delete

[13] Fix | Delete

* @since 5.5.0

[14] Fix | Delete

[15] Fix | Delete

class WP_Sitemaps_Taxonomies extends WP_Sitemaps_Provider {

[16] Fix | Delete

/**

[17] Fix | Delete

* WP_Sitemaps_Taxonomies constructor.

[18] Fix | Delete

[19] Fix | Delete

* @since 5.5.0

[20] Fix | Delete

[21] Fix | Delete

public function __construct() {

[22] Fix | Delete

$this->name = 'taxonomies';

[23] Fix | Delete

$this->object_type = 'term';

[24] Fix | Delete

}

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Returns all public, registered taxonomies.

[28] Fix | Delete

[29] Fix | Delete

* @since 5.5.0

[30] Fix | Delete

[31] Fix | Delete

* @return WP_Taxonomy[] Array of registered taxonomy objects keyed by their name.

[32] Fix | Delete

[33] Fix | Delete

public function get_object_subtypes() {

[34] Fix | Delete

$taxonomies = get_taxonomies( array( 'public' => true ), 'objects' );

[35] Fix | Delete

[36] Fix | Delete

$taxonomies = array_filter( $taxonomies, 'is_taxonomy_viewable' );

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* Filters the list of taxonomy object subtypes available within the sitemap.

[40] Fix | Delete

[41] Fix | Delete

* @since 5.5.0

[42] Fix | Delete

[43] Fix | Delete

* @param WP_Taxonomy[] $taxonomies Array of registered taxonomy objects keyed by their name.

[44] Fix | Delete

[45] Fix | Delete

return apply_filters( 'wp_sitemaps_taxonomies', $taxonomies );

[46] Fix | Delete

}

[47] Fix | Delete

[48] Fix | Delete

/**

[49] Fix | Delete

* Gets a URL list for a taxonomy sitemap.

[50] Fix | Delete

[51] Fix | Delete

* @since 5.5.0

[52] Fix | Delete

* @since 5.9.0 Renamed `$taxonomy` to `$object_subtype` to match parent class

[53] Fix | Delete

* for PHP 8 named parameter support.

[54] Fix | Delete

[55] Fix | Delete

* @param int $page_num Page of results.

[56] Fix | Delete

* @param string $object_subtype Optional. Taxonomy name. Default empty.

[57] Fix | Delete

* @return array[] Array of URL information for a sitemap.

[58] Fix | Delete

[59] Fix | Delete

public function get_url_list( $page_num, $object_subtype = '' ) {

[60] Fix | Delete

// Restores the more descriptive, specific name for use within this method.

[61] Fix | Delete

$taxonomy = $object_subtype;

[62] Fix | Delete

[63] Fix | Delete

$supported_types = $this->get_object_subtypes();

[64] Fix | Delete

[65] Fix | Delete

// Bail early if the queried taxonomy is not supported.

[66] Fix | Delete

if ( ! isset( $supported_types[ $taxonomy ] ) ) {

[67] Fix | Delete

return array();

[68] Fix | Delete

}

[69] Fix | Delete

[70] Fix | Delete

/**

[71] Fix | Delete

* Filters the taxonomies URL list before it is generated.

[72] Fix | Delete

[73] Fix | Delete

* Returning a non-null value will effectively short-circuit the generation,

[74] Fix | Delete

* returning that value instead.

[75] Fix | Delete

[76] Fix | Delete

* @since 5.5.0

[77] Fix | Delete

[78] Fix | Delete

* @param array[]|null $url_list The URL list. Default null.

[79] Fix | Delete

* @param string $taxonomy Taxonomy name.

[80] Fix | Delete

* @param int $page_num Page of results.

[81] Fix | Delete

[82] Fix | Delete

$url_list = apply_filters(

[83] Fix | Delete

'wp_sitemaps_taxonomies_pre_url_list',

[84] Fix | Delete

null,

[85] Fix | Delete

$taxonomy,

[86] Fix | Delete

$page_num

[87] Fix | Delete

);

[88] Fix | Delete

[89] Fix | Delete

if ( null !== $url_list ) {

[90] Fix | Delete

return $url_list;

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete

$url_list = array();

[94] Fix | Delete

[95] Fix | Delete

// Offset by how many terms should be included in previous pages.

[96] Fix | Delete

$offset = ( $page_num - 1 ) * wp_sitemaps_get_max_urls( $this->object_type );

[97] Fix | Delete

[98] Fix | Delete

$args = $this->get_taxonomies_query_args( $taxonomy );

[99] Fix | Delete

$args['fields'] = 'all';

[100] Fix | Delete

$args['offset'] = $offset;

[101] Fix | Delete

[102] Fix | Delete

$taxonomy_terms = new WP_Term_Query( $args );

[103] Fix | Delete

[104] Fix | Delete

if ( ! empty( $taxonomy_terms->terms ) ) {

[105] Fix | Delete

foreach ( $taxonomy_terms->terms as $term ) {

[106] Fix | Delete

$term_link = get_term_link( $term, $taxonomy );

[107] Fix | Delete

[108] Fix | Delete

if ( is_wp_error( $term_link ) ) {

[109] Fix | Delete

continue;

[110] Fix | Delete

}

[111] Fix | Delete

[112] Fix | Delete

$sitemap_entry = array(

[113] Fix | Delete

'loc' => $term_link,

[114] Fix | Delete

);

[115] Fix | Delete

[116] Fix | Delete

/**

[117] Fix | Delete

* Filters the sitemap entry for an individual term.

[118] Fix | Delete

[119] Fix | Delete

* @since 5.5.0

[120] Fix | Delete

* @since 6.0.0 Added `$term` argument containing the term object.

[121] Fix | Delete

[122] Fix | Delete

* @param array $sitemap_entry Sitemap entry for the term.

[123] Fix | Delete

* @param int $term_id Term ID.

[124] Fix | Delete

* @param string $taxonomy Taxonomy name.

[125] Fix | Delete

* @param WP_Term $term Term object.

[126] Fix | Delete

[127] Fix | Delete

$sitemap_entry = apply_filters( 'wp_sitemaps_taxonomies_entry', $sitemap_entry, $term->term_id, $taxonomy, $term );

[128] Fix | Delete

$url_list[] = $sitemap_entry;

[129] Fix | Delete

}

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

return $url_list;

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

/**

[136] Fix | Delete

* Gets the max number of pages available for the object type.

[137] Fix | Delete

[138] Fix | Delete

* @since 5.5.0

[139] Fix | Delete

* @since 5.9.0 Renamed `$taxonomy` to `$object_subtype` to match parent class

[140] Fix | Delete

* for PHP 8 named parameter support.

[141] Fix | Delete

[142] Fix | Delete

* @param string $object_subtype Optional. Taxonomy name. Default empty.

[143] Fix | Delete

* @return int Total number of pages.

[144] Fix | Delete

[145] Fix | Delete

public function get_max_num_pages( $object_subtype = '' ) {

[146] Fix | Delete

if ( empty( $object_subtype ) ) {

[147] Fix | Delete

return 0;

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

// Restores the more descriptive, specific name for use within this method.

[151] Fix | Delete

$taxonomy = $object_subtype;

[152] Fix | Delete

[153] Fix | Delete

/**

[154] Fix | Delete

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

[155] Fix | Delete

[156] Fix | Delete

* Passing a non-null value will short-circuit the generation,

[157] Fix | Delete

* returning that value instead.

[158] Fix | Delete

[159] Fix | Delete

* @since 5.5.0

[160] Fix | Delete

[161] Fix | Delete

* @param int|null $max_num_pages The maximum number of pages. Default null.

[162] Fix | Delete

* @param string $taxonomy Taxonomy name.

[163] Fix | Delete

[164] Fix | Delete

$max_num_pages = apply_filters( 'wp_sitemaps_taxonomies_pre_max_num_pages', null, $taxonomy );

[165] Fix | Delete

[166] Fix | Delete

if ( null !== $max_num_pages ) {

[167] Fix | Delete

return $max_num_pages;

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

$term_count = wp_count_terms( $this->get_taxonomies_query_args( $taxonomy ) );

[171] Fix | Delete

[172] Fix | Delete

return (int) ceil( $term_count / wp_sitemaps_get_max_urls( $this->object_type ) );

[173] Fix | Delete

}

[174] Fix | Delete

[175] Fix | Delete

/**

[176] Fix | Delete

* Returns the query args for retrieving taxonomy terms to list in the sitemap.

[177] Fix | Delete

[178] Fix | Delete

* @since 5.5.0

[179] Fix | Delete

[180] Fix | Delete

* @param string $taxonomy Taxonomy name.

[181] Fix | Delete

* @return array Array of WP_Term_Query arguments.

[182] Fix | Delete

[183] Fix | Delete

protected function get_taxonomies_query_args( $taxonomy ) {

[184] Fix | Delete

/**

[185] Fix | Delete

* Filters the taxonomy terms query arguments.

[186] Fix | Delete

[187] Fix | Delete

* Allows modification of the taxonomy query arguments before querying.

[188] Fix | Delete

[189] Fix | Delete

* @see WP_Term_Query for a full list of arguments

[190] Fix | Delete

[191] Fix | Delete

* @since 5.5.0

[192] Fix | Delete

[193] Fix | Delete

* @param array $args Array of WP_Term_Query arguments.

[194] Fix | Delete

* @param string $taxonomy Taxonomy name.

[195] Fix | Delete

[196] Fix | Delete

$args = apply_filters(

[197] Fix | Delete

'wp_sitemaps_taxonomies_query_args',

[198] Fix | Delete

array(

[199] Fix | Delete

'taxonomy' => $taxonomy,

[200] Fix | Delete

'orderby' => 'term_order',

[201] Fix | Delete

'number' => wp_sitemaps_get_max_urls( $this->object_type ),

[202] Fix | Delete

'hide_empty' => true,

[203] Fix | Delete

'hierarchical' => false,

[204] Fix | Delete

'update_term_meta_cache' => false,

[205] Fix | Delete

[206] Fix | Delete

$taxonomy

[207] Fix | Delete

);

[208] Fix | Delete

[209] Fix | Delete

return $args;

[210] Fix | Delete

}

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete