概要
get_all_category_ids 関数は、WordPressのすべてのカテゴリのIDを配列として取得するために使用されます。この関数は、カテゴリの一覧を取得したり、特定の条件に基づいてフィルタリングしたりする際に役立ちます。以下のような機能を実装する際によく使われます。
- カテゴリに基づく投稿のフィルタリング
- カスタムなナビゲーションメニューの作成
- 投稿やページに関連するカテゴリの表示
- カテゴリごとの統計情報の収集
- カテゴリタームに基づくサイドバーウィジェットの生成
- カテゴリに関連する外部データの取得
- カテゴリIDに基づくスクリプトやスタイルの読み込み
- タクソノミーに関連したクエリの最適化
構文
$category_ids = get_all_category_ids();
パラメータ
この関数は特にパラメータを持ちません。
戻り値
カテゴリのIDを含む配列を返します。カテゴリが存在しない場合は、空の配列が返されます。
関連する関数
使用可能なバージョン
get_all_category_ids 関数は、WordPress バージョン 3.0 以降で使用可能です。
コアファイルのパス
wp-includes/taxonomy.php
この関数のアクションでの使用可能性
| アクション名 | 使用例 |
|---|---|
| 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バージョンで非推奨または削除されたことはありません。
サンプルコード
サンプルコード1: すべてのカテゴリIDを取得し、表示する
$category_ids = get_all_category_ids();
echo 'すべてのカテゴリID: ' . implode(', ', $category_ids);
このコードは、すべてのカテゴリIDを取得し、それをカンマ区切りの文字列として表示します。
サンプルコード2: 特定の投稿タイプに基づきカテゴリIDを取得
$category_ids = get_all_category_ids();
foreach ($category_ids as $id) {
$category = get_category($id);
if ($category->count > 0) {
echo $category->name . ' (ID: ' . $id . ')<br>';
}
}
このコードは、すべてのカテゴリを取得し、投稿があるカテゴリのみを表示します。
サンプルコード3: 検索フォームにカテゴリの選択肢を表示
$category_ids = get_all_category_ids();
echo '<select name="category">';
foreach ($category_ids as $id) {
$category = get_category($id);
echo '<option value="' . $id . '">' . $category->name . '</option>';
}
echo '</select>';
このコードは、すべてのカテゴリを選択肢として持つドロップダウンメニューを生成します。
サンプルコード4: カテゴリIDを使ってカスタムクエリを実行
$category_ids = get_all_category_ids();
$query_args = array(
'category__in' => $category_ids,
'posts_per_page' => 5,
);
$custom_query = new WP_Query($query_args);
while ($custom_query->have_posts()) {
$custom_query->the_post();
echo '<h2>' . get_the_title() . '</h2>';
}
wp_reset_postdata();
このコードは、すべてのカテゴリを使用してカスタムクエリを実行し、最新の5件の投稿を表示します。
サンプルコード5: フロントエンドでカテゴリIDを表示するショートコード
function display_category_ids() {
$category_ids = get_all_category_ids();
return 'カテゴリID: ' . implode(', ', $category_ids);
}
add_shortcode('show_category_ids', 'display_category_ids');
このコードは、[show_category_ids] というショートコードを使用して、フロントエンドでカテゴリIDを表示する機能を追加します。