概要
wp_sitemaps_get_max_urlsフィルタは、WordPressにおけるXMLサイトマップのURL数を取得する際に使用されるフックです。このフィルタは、サイトマップで表示する最大URL数を変更したい場合に非常に便利です。このフィルタを使用して、さまざまな設定や要件に応じてURL数を制限したり増やしたりすることができます。以下は、その機能を実装する際によく使用されるケースの一覧です。
- サイトマップのパフォーマンス最適化
- 特定のURLを除外または追加したい場合
- 大規模サイトにおける管理の簡素化
- モバイルフレンドリーなサイトマップの生成
- SEO施策の一環としてのカスタマイズ
- コンテンツタイプのバランスを取るための設定
- 特定の期間にのみ有効なサイトマップの生成
- 外部リソースとの統合でサイトマップを生成する際の調整
構文
apply_filters( 'wp_sitemaps_get_max_urls', $max_urls, $object_type );
パラメータ
$max_urls: 整数型。デフォルトの最大URL数。$object_type: 文字列型。URLが属するオブジェクトのタイプ（例: ‘post’, ‘page’ など）。
戻り値
整数型の最大URL数。
関連する関数
使用可能なバージョン
このフィルタはWordPress 5.5以降で使用可能です。
コアファイルのパス
wp-includes/class-wp-sitemaps.php
サンプルコード
サンプルコード1: 最大URL数を変更する
add_filter( 'wp_sitemaps_get_max_urls', function( $max_urls ) {
return 200; // 最大URL数を200に設定します。
});
このコードは、XMLサイトマップ内の最大URL数を200に設定するものです。
サンプルコード2: 特定の投稿タイプに対して最大URL数を設定する
add_filter( 'wp_sitemaps_get_max_urls', function( $max_urls, $object_type ) {
if ( 'post' === $object_type ) {
return 100; // 投稿タイプの最大URL数を100に変更。
}
return $max_urls;
}, 10, 2 );
このコードでは、特定の投稿タイプ（この場合は「post」）の最大URL数を100に変更しています。
サンプルコード3: URL数を動的に変更する
add_filter( 'wp_sitemaps_get_max_urls', function( $max_urls, $object_type ) {
if ( is_admin() ) {
return 300; // 管理画面では最大URL数を300に。
}
return $max_urls;
}, 10, 2 );
このコードは、管理画面で表示する場合に最大URL数を300に変更します。
サンプルコード4: サイトの規模に応じてURL数を調整
add_filter( 'wp_sitemaps_get_max_urls', function( $max_urls ) {
if ( count_users() > 500 ) {
return 500; // ユーザーが500人を超える場合は最大URL数を500に設定。
}
return $max_urls;
});
このコードは、ユーザー数に応じて最大URL数を調整するものです。
サンプルコード5: 環境に応じた設定
add_filter( 'wp_sitemaps_get_max_urls', function( $max_urls ) {
if ( defined( 'WP_ENV' ) && WP_ENV === 'production' ) {
return 1000; // 本番環境の場合、最大URL数を1000に設定。
}
return $max_urls;
});
このコードは、本番環境での最大URL数を1000に設定するものです。
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
このフィルタは特定のWordPressバージョンで非推奨または削除された情報はありません。