概要
get_cat_ID 関数は、指定したカテゴリー名をもとに、そのカテゴリーのIDを取得するためのWordPressの関数です。この関数は、投稿やカスタム投稿タイプに関連付けられたカテゴリーを操作する際によく使われます。具体的には、以下のような機能を実装する際によく使用されます。
- 投稿のカテゴリー表示
- カテゴリーごとの投稿のリスト作成
- カテゴリーに基づくカスタムクエリの実行
- カテゴリーのリンク生成
- ダッシュボードでのカテゴリー管理機能の実装
- カテゴリー別のウィジェットや短縮コードの作成
- カスタムフィールドやメタデータにおけるカテゴリーの利用
- カテゴリーに基づくアクセス制御やロジックの実装
構文
get_cat_ID( $category_name );
パラメータ
$category_name(string) – カテゴリー名。IDを取得したいカテゴリーの名前を指定します。
戻り値
- 成功した場合は指定されたカテゴリーのID（integer）を返します。カテゴリーが存在しない場合は0を返します。
関連する関数
使用可能なバージョン
get_cat_ID 関数は、WordPressのすべてのバージョンで利用可能です。
コアファイル内のパス
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 |
サンプルコード
サンプルコード1: カテゴリーIDを取得して表示
$category_id = get_cat_ID('ニュース');
echo 'ニュースカテゴリーのIDは: ' . $category_id;
このサンプルコードは、”ニュース”という名称のカテゴリーのIDを取得し、その値を画面に表示します。
サンプルコード2: カテゴリーIDを使用して投稿を取得
$category_id = get_cat_ID('ブログ');
$args = array(
'category' => $category_id,
);
$posts = get_posts($args);
foreach ($posts as $post) {
setup_postdata($post);
the_title();
}
このサンプルコードは、”ブログ”カテゴリーのIDを取得し、そのIDを利用して関連する投稿を取得して表示します。
サンプルコード3: カテゴリーIDを使ったクエリの実行
$category_id = get_cat_ID('テクノロジー');
$query = new WP_Query(array(
'cat' => $category_id,
));
if ($query->have_posts()) {
while ($query->have_posts()) {
$query->the_post();
the_title();
}
}
このコードは、”テクノロジー”カテゴリーのIDを使って、WP_Queryを利用し、そのカテゴリーに属する投稿を取得して表示します。
サンプルコード4: カテゴリーの判定と条件分岐
$category_name = 'スポーツ';
if (get_cat_ID($category_name)) {
echo $category_name . 'カテゴリーは存在します。';
} else {
echo $category_name . 'カテゴリーは存在しません。';
}
このサンプルコードは、指定したカテゴリーが存在するかを判定し、その結果を表示します。
サンプルコード5: ダッシュボードでカテゴリーIDを使う
function my_admin_notice() {
$category_id = get_cat_ID('未分類');
echo '<div class="notice notice-success"><p>未分類のカテゴリーIDは ' . $category_id . ' です。</p></div>';
}
add_action('admin_notices', 'my_admin_notice');
このサンプルコードは、WordPressの管理画面で未分類カテゴリーのIDを表示する通知を作成します。