概要
get_the_category_by_ID 関数は、特定のカテゴリーIDを指定して、そのカテゴリーの情報を取得するための関数です。この関数は、主に以下の機能を実装する際に使用されます：
- カテゴリー名を表示する
- カテゴリーに関連する投稿をフィルタリングする
- ナビゲーションメニューのカテゴリーリンクを作成する
- カテゴリーウィジェットをカスタマイズする
- 投稿のメタ情報を表示する
- テーマやプラグインの設定画面にカテゴリーを追加する
- カスタム投稿タイプのカテゴリーに基づくクエリを実行する
- SEO対策のためにカテゴリーに関連する情報を取得する
構文
get_the_category_by_ID( $category_id );
パラメータ
$category_id(int) : 取得したいカテゴリーのID。
戻り値
- カテゴリーの情報が格納されたオブジェクト、または該当するカテゴリーが存在しない場合は
null。
関連する関数
使用可能なバージョン
- この関数は WordPress 2.5.0 以降で使用可能です。
コアファイルのパス
wp-includes/category.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
$category_id = 5; // 取得したいカテゴリーのIDを指定
$category = get_the_category_by_ID($category_id);
if ($category) {
echo "カテゴリー名: " . $category->name;
} else {
echo "指定したカテゴリーは存在しません。";
}
説明: 指定したカテゴリーIDからカテゴリー名を取得し、存在する場合は表示します。存在しない場合はその旨を表示します。
サンプルコード 2
$category_id = 10; // カテゴリーIDを指定
$category = get_the_category_by_ID($category_id);
if ($category) {
echo '<a href="'. esc_url(get_category_link($category->term_id)) .'">'. esc_html($category->name) .'</a>';
}
説明: 指定したカテゴリーIDからカテゴリー情報を取得し、そのカテゴリーへのリンクを生成します。
サンプルコード 3
function display_category_info($category_id) {
$category = get_the_category_by_ID($category_id);
if ($category) {
echo "カテゴリー名: " . $category->name . "<br>";
echo "カテゴリー説明: " . $category->description;
} else {
echo "このカテゴリーは存在しません。";
}
}
display_category_info(3);
説明: 指定したカテゴリーIDの情報を表示するカスタム関数を定義します。
サンプルコード 4
$category_id = 8; // 取得したいカテゴリーのID
$category = get_the_category_by_ID($category_id);
if ($category) {
echo "<h2>商品のカテゴリー: " . esc_html($category->name) . "</h2>";
}
説明: 指定したカテゴリーIDの情報を取得し、HTMLタグを用いてカテゴリー名を表示します。
サンプルコード 5
$posts = get_posts(array(
'category' => 4, // カテゴリーIDを指定
));
if ($posts) {
foreach($posts as $post) {
echo '<h3>' . esc_html($post->post_title) . '</h3>';
echo 'カテゴリー: ' . esc_html(get_the_category_by_ID($post->post_category[0]));
}
} else {
echo '投稿が見つかりませんでした。';
}
説明: 指定したカテゴリーIDに基づいて投稿を取得し、それぞれの投稿のカテゴリー名を表示します。