概要
has_tag関数は、特定の投稿記事に投稿タグが付属しているかどうかを調べるためのワードプレスの関数です。この関数は、特定のタグが付けられているかの確認を行う際によく使用されます。具体的には、以下のような機能を実装する際に役立ちます。
- 特定のタグに関連するコンテンツを表示する場合
- タグに基づいて異なるスタイリングを適用する場合
- 投稿が特定のタグを持たない場合の条件分岐
- タグに基づくフィルタリングを行う場合
- サイトのSEO対策を強化する場合
- カスタムクエリの作成においてタグを考慮に入れる場合
- タグクラウドに動的なフィルタリングを適用する場合
- タグが関連する投稿のリストを表示する場合
構文
has_tag( $tag, $post );
パラメータ
$tag（string|array）：チェックしたいタグのスラッグ、またはタグのID。複数タグを配列で指定可能。$post（int|WP_Post）：チェックする投稿のIDまたはWP_Postオブジェクト。省略すると、現在の投稿が対象になる。
戻り値
- タグが付いていれば
trueを返し、付いていなければfalseを返す。
関連する関数
使用可能なバージョン
has_tag関数は、WordPress Version 1.5.0で導入されています。
コアファイルのパス
wp-includes/category-template.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
特定のタグがある場合にメッセージを表示する
if ( has_tag( 'news' ) ) {
echo 'この投稿はニュースタグが付いています。';
}
このコードは、現在の投稿が「news」タグを持っているかどうかを確認し、持っていれば特定のメッセージを表示します。
サンプルコード 2
複数のタグを確認してフロントエンドのスタイルを変更する
if ( has_tag( array( 'featured', 'highlight' ) ) ) {
echo '<div class="highlighted-post">この投稿は特集されています。</div>';
}
このコードでは、「featured」または「highlight」タグが付いている場合、特別なスタイルを持つメッセージを表示します。
サンプルコード 3
特定の投稿のタグを確認する
$post_id = 42; // チェックしたい投稿のID
if ( has_tag( 'example-tag', $post_id ) ) {
echo '投稿ID ' . $post_id . ' は example-tag タグを持っています。';
}
このコードでは、投稿ID 42について「example-tag」タグが付いているか確認し、該当するメッセージを表示します。
サンプルコード 4
タグがなければエラーメッセージを表示する
if ( ! has_tag() ) {
echo 'この投稿にはタグが設定されていません。';
}
このコードは、現在の投稿にタグが付いていない場合、エラーメッセージを表示します。
サンプルコード 5
カスタムタグに従って投稿のフィルタリングを行う
$args = array(
'tag' => 'custom-tag',
);
$custom_posts = new WP_Query( $args );
if ( $custom_posts->have_posts() ) {
while ( $custom_posts->have_posts() ) {
$custom_posts->the_post();
echo '<h2>' . get_the_title() . '</h2>';
}
wp_reset_postdata();
}
このコードは、「custom-tag」タグが付けられた投稿を取得してタイトルを表示します。