概要
get_cat_name関数は、WordPressのカテゴリー名を取得するための便利な関数です。この関数は、サイトのカテゴリー情報を表示したり、カスタムテンプレートで使用する際などに頻繁に利用されます。具体的には、以下のような場面で使用されることがよくあります。
- カテゴリーのタイトルを表示する。
- サイトのメニューにカテゴリー名を追加する。
- カテゴリーに基づいたコンテンツをフィルタリングする。
- SEO目的でカテゴリー名をマークアップする。
- カスタムテーマで動的なナビゲーションを作成する。
- ウィジェットやサイドバーにカテゴリーリストを表示する。
- カテゴリー別ページのヘッダーを作成する。
- カテゴリーに関連するバナーや広告を表示する。
構文
get_cat_name( $category_id );
パラメータ
$category_id(int) – カテゴリーのID。取得したいカテゴリー名に関連付けられたIDを指定します。
戻り値
- 取得したカテゴリー名 (string)。指定したIDに関連付けられたカテゴリー名が返されます。存在しないIDの場合は空文字列が返されます。
関連する関数
使用可能なバージョン
get_cat_name関数は、WordPressの古いバージョンから存在し、特に非推奨や削除されたバージョンはありません。
コアファイルのパス
get_cat_name関数は、通常 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;
$category_name = get_cat_name($category_id);
echo 'カテゴリー名: ' . $category_name;
このコードは、IDが5のカテゴリー名を取得し表示します。
サンプルコード2: 複数のカテゴリー名を取得
$category_ids = array(1, 2, 3);
foreach ($category_ids as $category_id) {
echo get_cat_name($category_id) . '<br>';
}
このコードは、1, 2, 3の各カテゴリーIDからカテゴリー名を取得し、改行付きで表示します。
サンプルコード3: カテゴリー名を使用した条件分岐
$category_id = 4;
if (get_cat_name($category_id) === '特定のカテゴリー名') {
echo 'このカテゴリーは特別です。';
}
このコードは、特定のカテゴリー名を持つ場合に特定のメッセージを表示します。
サンプルコード4: カスタムテンプレートでの使用
<?php
$category_id = get_query_var('cat');
if ($category_id) {
echo '<h1>' . get_cat_name($category_id) . '</h1>';
}
?>
このコードは、クエリ変数からカテゴリーIDを取得し、そのカテゴリー名を表示します。
サンプルコード5: カテゴリー名とリンクを表示
$category_id = 2;
$category_name = get_cat_name($category_id);
$category_link = get_category_link($category_id);
echo '<a href="' . esc_url($category_link) . '">' . esc_html($category_name) . '</a>';
このコードは、カテゴリー名を取得し、そのリンクを作成して表示します。