wp_sitemaps_get_max_urls()


WordPressの関数wp_sitemaps_get_max_urls()は、サイトマップに含めることができるURLの最大数を取得するために使用されます。

構文

wp_sitemaps_get_max_urls( string $sitemap_name );
  • $sitemap_name(string)—サイトマップの名前(例:’posts’,’pages’など)

例1:投稿サイトマップの最大URL数を取得

投稿タイプのサイトマップに含めることができるURLの最大数を表示します。

echo wp_sitemaps_get_max_urls('posts');

例2:固定ページのサイトマップ制限を確認

固定ページのサイトマップで許可されているURLの最大数を確認します。

$max_pages = wp_sitemaps_get_max_urls('pages');

例3:カスタム投稿タイプの制限を取得

カスタム投稿タイプ’products’のサイトマップ制限を取得します。

$product_limit = wp_sitemaps_get_max_urls('products');

例4:サイトマップ制限のデフォルト値を取得

デフォルトのサイトマップ制限値を取得します。

$default_limit = wp_sitemaps_get_max_urls('');

例5:条件分岐でサイトマップ制限をチェック

サイトマップのURL数が制限に達しているかどうかを確認します。

if(count($urls) >= wp_sitemaps_get_max_urls('posts')){echo '制限に達しました';}

例6:フィルターフックで制限値を変更

wp_sitemaps_max_urlsフィルターを使用して制限値を変更します。

add_filter('wp_sitemaps_max_urls',function($max_urls){return 1000;});

例7:すべてのサイトマップタイプの制限を表示

登録されているすべてのサイトマップタイプの制限値を表示します。

foreach(wp_get_sitemaps() as $sitemap){echo $sitemap->name.':'.wp_sitemaps_get_max_urls($sitemap->name);}

注意点

  • この関数はWordPress5.5以降で利用可能です
  • 無効なサイトマップ名を指定した場合、デフォルト値が返されます
  • サイトマップの制限値はフィルターで変更可能です

関連機能: