<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Sitemaps: WP_Sitemaps_Provider class

[2] Fix | Delete

*

[3] Fix | Delete

* This class is a base class for other sitemap providers to extend and contains shared functionality.

[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

* Class WP_Sitemaps_Provider.

[12] Fix | Delete

*

[13] Fix | Delete

* @since 5.5.0

[14] Fix | Delete

*/

[15] Fix | Delete

#[AllowDynamicProperties]

[16] Fix | Delete

abstract class WP_Sitemaps_Provider {

[17] Fix | Delete

/**

[18] Fix | Delete

* Provider name.

[19] Fix | Delete

*

[20] Fix | Delete

* This will also be used as the public-facing name in URLs.

[21] Fix | Delete

*

[22] Fix | Delete

* @since 5.5.0

[23] Fix | Delete

*

[24] Fix | Delete

* @var string

[25] Fix | Delete

*/

[26] Fix | Delete

protected $name = '';

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Object type name (e.g. 'post', 'term', 'user').

[30] Fix | Delete

*

[31] Fix | Delete

* @since 5.5.0

[32] Fix | Delete

*

[33] Fix | Delete

* @var string

[34] Fix | Delete

*/

[35] Fix | Delete

protected $object_type = '';

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* Gets a URL list for a sitemap.

[39] Fix | Delete

*

[40] Fix | Delete

* @since 5.5.0

[41] Fix | Delete

*

[42] Fix | Delete

* @param int $page_num Page of results.

[43] Fix | Delete

* @param string $object_subtype Optional. Object subtype name. Default empty.

[44] Fix | Delete

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

[45] Fix | Delete

*/

[46] Fix | Delete

abstract public function get_url_list( $page_num, $object_subtype = '' );

[47] Fix | Delete

[48] Fix | Delete

/**

[49] Fix | Delete

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

[50] Fix | Delete

*

[51] Fix | Delete

* @since 5.5.0

[52] Fix | Delete

*

[53] Fix | Delete

* @param string $object_subtype Optional. Object subtype. Default empty.

[54] Fix | Delete

* @return int Total number of pages.

[55] Fix | Delete

*/

[56] Fix | Delete

abstract public function get_max_num_pages( $object_subtype = '' );

[57] Fix | Delete

[58] Fix | Delete

/**

[59] Fix | Delete

* Gets data about each sitemap type.

[60] Fix | Delete

*

[61] Fix | Delete

* @since 5.5.0

[62] Fix | Delete

*

[63] Fix | Delete

* @return array[] Array of sitemap types including object subtype name and number of pages.

[64] Fix | Delete

*/

[65] Fix | Delete

public function get_sitemap_type_data() {

[66] Fix | Delete

$sitemap_data = array();

[67] Fix | Delete

[68] Fix | Delete

$object_subtypes = $this->get_object_subtypes();

[69] Fix | Delete

[70] Fix | Delete

/*

[71] Fix | Delete

* If there are no object subtypes, include a single sitemap for the

[72] Fix | Delete

* entire object type.

[73] Fix | Delete

*/

[74] Fix | Delete

if ( empty( $object_subtypes ) ) {

[75] Fix | Delete

$sitemap_data[] = array(

[76] Fix | Delete

'name' => '',

[77] Fix | Delete

'pages' => $this->get_max_num_pages(),

[78] Fix | Delete

);

[79] Fix | Delete

return $sitemap_data;

[80] Fix | Delete

}

[81] Fix | Delete

[82] Fix | Delete

// Otherwise, include individual sitemaps for every object subtype.

[83] Fix | Delete

foreach ( $object_subtypes as $object_subtype_name => $data ) {

[84] Fix | Delete

$object_subtype_name = (string) $object_subtype_name;

[85] Fix | Delete

[86] Fix | Delete

$sitemap_data[] = array(

[87] Fix | Delete

'name' => $object_subtype_name,

[88] Fix | Delete

'pages' => $this->get_max_num_pages( $object_subtype_name ),

[89] Fix | Delete

);

[90] Fix | Delete

}

[91] Fix | Delete

[92] Fix | Delete

return $sitemap_data;

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

/**

[96] Fix | Delete

* Lists sitemap pages exposed by this provider.

[97] Fix | Delete

*

[98] Fix | Delete

* The returned data is used to populate the sitemap entries of the index.

[99] Fix | Delete

*

[100] Fix | Delete

* @since 5.5.0

[101] Fix | Delete

*

[102] Fix | Delete

* @return array[] Array of sitemap entries.

[103] Fix | Delete

*/

[104] Fix | Delete

public function get_sitemap_entries() {

[105] Fix | Delete

$sitemaps = array();

[106] Fix | Delete

[107] Fix | Delete

$sitemap_types = $this->get_sitemap_type_data();

[108] Fix | Delete

[109] Fix | Delete

foreach ( $sitemap_types as $type ) {

[110] Fix | Delete

for ( $page = 1; $page <= $type['pages']; $page++ ) {

[111] Fix | Delete

$sitemap_entry = array(

[112] Fix | Delete

'loc' => $this->get_sitemap_url( $type['name'], $page ),

[113] Fix | Delete

);

[114] Fix | Delete

[115] Fix | Delete

/**

[116] Fix | Delete

* Filters the sitemap entry for the sitemap index.

[117] Fix | Delete

*

[118] Fix | Delete

* @since 5.5.0

[119] Fix | Delete

*

[120] Fix | Delete

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

[121] Fix | Delete

* @param string $object_type Object empty name.

[122] Fix | Delete

* @param string $object_subtype Object subtype name.

[123] Fix | Delete

* Empty string if the object type does not support subtypes.

[124] Fix | Delete

* @param int $page Page number of results.

[125] Fix | Delete

*/

[126] Fix | Delete

$sitemap_entry = apply_filters( 'wp_sitemaps_index_entry', $sitemap_entry, $this->object_type, $type['name'], $page );

[127] Fix | Delete

[128] Fix | Delete

$sitemaps[] = $sitemap_entry;

[129] Fix | Delete

}

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

return $sitemaps;

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

/**

[136] Fix | Delete

* Gets the URL of a sitemap entry.

[137] Fix | Delete

*

[138] Fix | Delete

* @since 5.5.0

[139] Fix | Delete

*

[140] Fix | Delete

* @global WP_Rewrite $wp_rewrite WordPress rewrite component.

[141] Fix | Delete

*

[142] Fix | Delete

* @param string $name The name of the sitemap.

[143] Fix | Delete

* @param int $page The page of the sitemap.

[144] Fix | Delete

* @return string The composed URL for a sitemap entry.

[145] Fix | Delete

*/

[146] Fix | Delete

public function get_sitemap_url( $name, $page ) {

[147] Fix | Delete

global $wp_rewrite;

[148] Fix | Delete

[149] Fix | Delete

// Accounts for cases where name is not included, ex: sitemaps-users-1.xml.

[150] Fix | Delete

$params = array_filter(

[151] Fix | Delete

array(

[152] Fix | Delete

'sitemap' => $this->name,

[153] Fix | Delete

'sitemap-subtype' => $name,

[154] Fix | Delete

'paged' => $page,

[155] Fix | Delete

)

[156] Fix | Delete

);

[157] Fix | Delete

[158] Fix | Delete

$basename = sprintf(

[159] Fix | Delete

'/wp-sitemap-%1$s.xml',

[160] Fix | Delete

implode( '-', $params )

[161] Fix | Delete

);

[162] Fix | Delete

[163] Fix | Delete

if ( ! $wp_rewrite->using_permalinks() ) {

[164] Fix | Delete

$basename = '/?' . http_build_query( $params, '', '&' );

[165] Fix | Delete

}

[166] Fix | Delete

[167] Fix | Delete

return home_url( $basename );

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

/**

[171] Fix | Delete

* Returns the list of supported object subtypes exposed by the provider.

[172] Fix | Delete

*

[173] Fix | Delete

* @since 5.5.0

[174] Fix | Delete

*

[175] Fix | Delete

* @return array List of object subtypes objects keyed by their name.

[176] Fix | Delete

*/

[177] Fix | Delete

public function get_object_subtypes() {

[178] Fix | Delete

return array();

[179] Fix | Delete

}

[180] Fix | Delete

}

[181] Fix | Delete

[182] Fix | Delete