WP_Sitemaps_Provider

17#[AllowDynamicProperties]18abstract class WP_Sitemaps_Provider {19	/**20	 * Provider name.21	 *22	 * This will also be used as the public-facing name in URLs.23	 *24	 * @since 5.5.025	 *26	 * @var string27	 */28	protected $name = '';29 30	/**31	 * Object type name (e.g. 'post', 'term', 'user').32	 *33	 * @since 5.5.034	 *35	 * @var string36	 */37	protected $object_type = '';38 39	/**40	 * Gets a URL list for a sitemap.41	 *42	 * @since 5.5.043	 *44	 * @param int    $page_num       Page of results.45	 * @param string $object_subtype Optional. Object subtype name. Default empty.46	 * @return array[] Array of URL information for a sitemap.47	 */48	abstract public function get_url_list( $page_num, $object_subtype = '' );49 50	/**51	 * Gets the max number of pages available for the object type.52	 *53	 * @since 5.5.054	 *55	 * @param string $object_subtype Optional. Object subtype. Default empty.56	 * @return int Total number of pages.57	 */58	abstract public function get_max_num_pages( $object_subtype = '' );59 60	/**61	 * Gets data about each sitemap type.62	 *63	 * @since 5.5.064	 *65	 * @return array[] Array of sitemap types including object subtype name and number of pages.66	 */67	public function get_sitemap_type_data() {68		$sitemap_data = array();69 70		$object_subtypes = $this->get_object_subtypes();71 72		/*73		 * If there are no object subtypes, include a single sitemap for the74		 * entire object type.75		 */76		if ( empty( $object_subtypes ) ) {77			$sitemap_data[] = array(78				'name'  => '',79				'pages' => $this->get_max_num_pages(),80			);81			return $sitemap_data;82		}83 84		// Otherwise, include individual sitemaps for every object subtype.85		foreach ( $object_subtypes as $object_subtype_name => $data ) {86			$object_subtype_name = (string) $object_subtype_name;87 88			$sitemap_data[] = array(89				'name'  => $object_subtype_name,90				'pages' => $this->get_max_num_pages( $object_subtype_name ),91			);92		}93 94		return $sitemap_data;95	}96