WP_Sitemaps_Provider{} │ WP 5.5.0

Базовий абстрактний клас для створення провайдера Карти WordPress.

Провайдер створюється шляхом створення свого класу на основі цього та подальшої його реєстрації за допомогою функції wp_register_sitemap_provider() .

add_filter( 'init', 'wpkama_register_sitemap_providers');
function wpkama_register_sitemap_providers(){

	require_once __DIR__ .'/class-My_Sitemaps_Provider.php';

	$provider = New Coredata_Sitemaps_Provider();

	wp_register_sitemap_provider( 'provider_name', $provider );
}

Хуки із класу
class My_Sitemaps_Provider extends WP_Sitemaps_Provider { public function __construct() { $this->name = 'name'; $this->object_type = 'type'; } /** * Gets a URL list for a sitemap. * * @param int $page_num Page of results. * @param string $object_subtype Optional. Object subtype name. Default empty. * * @return array Array of URLs для sitemap. */ public function get_url_list( $page_num, $object_subtype = '' ) { // code here return $url_list; } /** * Gets the max number of pages available for the object type. * * @param string $object_subtype Optional. Object subtype. Default empty. * @return int Total number of pages. */ public function get_max_num_pages( $object_subtype = '' ) { $ total = 99999; return (int) ceil( $total / wp_sitemaps_get_max_urls( $this->object_type ) ); } }

Властивості

$name
(рядок) (обов’язковий)

Ім’я провайдера Використовується в URL-картки сайту. Має бути унікальним. Наприклад: /wp-sitemap-posts-post-1.xml– Posts тут це ім’я провайдера.

ВАЖЛИВО! Дозволяються лише символи a-z. Тобто. не можна використовувати тире, прогалини та малі. Неправильно: similar_posts, similar-posts, Similar. Правильно similarposts.

$object_type
(рядок) (обов’язковий)
Ім’я об’єкта, з яким працює провайдер (post, term, user). Має бути унікальним. Використовується/передається в хуки. Наприклад другий параметр хука
wp_sitemaps_index_entry .

Методи

Методи, які зазвичай потрібно визначати у спадковому класі:

get_object_subtypes()
Повинен повернути список підтипів, наприклад у постів типи постів. Повертає масив об’єктів, у ключах є імена підтипів.
get_url_list( $page_num, $subtype = ” )

Повинний повернути список посилань для кожної картки – список даних для тегів XML <url> . Виглядає цей список як масив масивів, кожен вкладений масив – це кожне посилання. Наприклад:

$url_list = [ [ 'loc'=> 'https://example.com/megamedia/audio/2610735' ], [ 'loc'=> 'https://example.com/megamedia/audio/9514241' ], ... ];
get_max_num_pages( $subtype = ” )
Повинен повернути число – загальна кількість елементів для переданого підтипу. Наприклад, для записів WP – це скільки всього записів зазначеного типу запису, наприклад, скільки всього сторінок (page).
db_query( $args )
Це свій довільний метод класу, який створює запит у БД і отримує дані за переданими параметрами, у тому числі тут враховується підтип і пагінація.

Усі методи:

  1. public get_max_num_pages( $object_subtype = ” )
  2. public get_object_subtypes()
  3. public get_sitemap_entries()
  4. public get_sitemap_type_data()
  5. public get_sitemap_url( $name, $page )
  6. public get_url_list( $page_num, $object_subtype = ” )

Приклади

0

#1 Провайдери з коробки

0

#2 Приклад створення провайдера

дивіться тут .

список змін

З версії 5.5.0Введено.

Код WP_Sitemaps_Provider{} WP 6.0.2

wp-includes/sitemaps/class-wp-sitemaps-provider.php 
abstract class WP_Sitemaps_Provider { /** * Provider name. * * Це буде також використано як public-facing name в URLs. * * @ Since 5.5.0 * * @var string */ protected $name = ''; /** * Object type name (eg 'post', 'term', 'user'). * * @ Since 5.5.0 * * @var string */ protected $object_type = ''; /** * Gets a URL list for a sitemap. * * @ Since 5.5.0 * * @param int $page_num Page of results. * @param string $object_subtype Optional. Object subtype name. Default empty. * @return array[] Array of URL information for sitemap. */ abstract public function get_url_list($page_num, $object_subtype = ''); /** * Gets the max number of pages available for the object type. * * @ Since 5.5.0 * * @param string $object_subtype Optional. Object subtype. Default empty. * @return int Total number of pages. */ abstract public function get_max_num_pages( $object_subtype = ''); /** * Gets data about each sitemap type. * * @ Since 5.5.0 * * @return array[] Array of sitemap types including object subtype name and number of pages. */ public function get_sitemap_type_data() { $ sitemap_data = array (); $object_subtypes = $this->get_object_subtypes(); // Якщо не є об'єктом subtypes, include single sitemap for the // entire object type. if ( empty( $object_subtypes ) ) { $ sitemap_data [] = array ( 'name' => '', 'pages' => $this->get_max_num_pages(), ); return $sitemap_data; } / / Іншіwise, включає окремі sitemaps для every object subtype. foreach ( $object_subtypes as $object_subtype_name => $data ) { $object_subtype_name = (string) $object_subtype_name; $ sitemap_data [] = array ( 'name' => $object_subtype_name, 'pages' => $this->get_max_num_pages( $object_subtype_name ), ); } return $sitemap_data; } /** * Lists sitemap pages exposed by this provider. * * Відновлені дані використовуються в населених мережах map entries of index. * * @ Since 5.5.0 * * @return array[] Array of sitemap entries. */ public function get_sitemap_entries() { $ sitemaps = array (); $sitemap_types = $this->get_sitemap_type_data(); foreach ( $sitemap_types as $type ) { for ( $page = 1; $page <= $type['pages']; $page ++ ) { $ sitemap_entry = array ( 'loc' => $this->get_sitemap_url( $type['name'], $page ), ); /** * Filters sitemap entry for sitemap index. * * @ Since 5.5.0 * * @param array $sitemap_entry Sitemap натисніть на post. * @param string $object_type Object empty name. * @param string $object_subtype Object subtype name. * Empty string if the object type does не support subtypes. * @param int $page Page number of results. */ $sitemap_entry = apply_filters( 'wp_sitemaps_index_entry', $sitemap_entry, $this->object_type, $type['name'], $page ); $sitemaps[] = $sitemap_entry; } } return $sitemaps; } /** * Gets the URL of a sitemap entry. * * @ Since 5.5.0 * * @global WP_Rewrite $wp_rewrite WordPress rewrite component. * * @param string $name Name of the sitemap. * @param int $page page of the sitemap. * @Return string Створена URL-адреса для веб-сайту. */ public function get_sitemap_url( $name, $page ) { global $wp_rewrite; // Accounts for cases where name is not included, ex: sitemaps-users-1.xml. $params = array_filter( array( 'sitemap' => $this->name, 'sitemap-subtype' => $name, 'paged' => $page, ) ); $basename = sprintf( '/wp-sitemap-%1$s.xml', implode( '-', $params ) ); if ( ! $wp_rewrite->using_permalinks() ) { $basename = '/?' . http_build_query( $params, '', '&' ); } return home_url ($ basename); } /** * Натисніть на list supported object subtypes exposed by the provider. * * @ Since 5.5.0 * * @return array List of object subtypes objects keyed by their name. */ public function get_object_subtypes() { return array(); } }

Sitemap (Карта сайту)

Класи

Залишити відповідь

Ваша e-mail адреса не оприлюднюватиметься. Обов’язкові поля позначені *