概要
has_category関数は、「投稿記事がカテゴリーに属しているか調べる」ために使用されるWordPressの関数です。この関数は、特定の投稿が特定のカテゴリーに属しているかを確認することができます。多くの場合、テーマやプラグインの開発において、特定のカテゴリーに基づいて表示内容を変更したり、条件付きロジックを実装したりする際に利用されます。
以下は、has_category関数の一般的な利用シーンの例です:
- 投稿のサイドバーで特定のカテゴリーを強調表示する。
- 特定のカテゴリーに属する投稿を異なるテンプレートで表示する。
- カテゴリーに基づいてアクセス制限をかける。
- カテゴリーベースのナビゲーションメニューを作成する。
- 特定のカテゴリーに属する投稿のみに広告を表示する。
- カテゴリーに基づくフォントスタイルやカラーを変更する。
- カテゴリーに則った関連投稿を表示する機能を追加する。
- 特定のカテゴリーに応じて投稿のメタデータをカスタマイズする。
構文
has_category( $category, $post_id );
パラメータ
$category(string|int|array) 必須: 調べたいカテゴリーのスラugs、ID、または配列。$post_id(int) オプション: 調べたい投稿のID。指定しない場合は現在の投稿が使用される。
戻り値
- bool: 指定した投稿がカテゴリーに属していれば
true、それ以外はfalseを返す。
関連する関数
使用可能なバージョン
- WordPress 1.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 | 〇 |
.has_category関数は特定のバージョンで非推奨または削除されたことはありません。