概要
get_the_tags関数は、WordPressの投稿データのタグ情報を取得するための関数です。この関数は主に以下のような機能を実装する際に使用されます。
- 投稿のタグを一覧表示する
- タグの数をカウントする
- 特定のタグが投稿に含まれているか確認する
- タグのリンクを生成して表示する
- タグ情報を条件に基づいてフィルタリングする
- 他の投稿との関連付けを表示する
- タグをもとにしたカスタムクエリを作成する
- タグを使ったSEO対策
構文
get_the_tags( $post_id );
パラメータ
$post_id(int) – 投稿ID。指定しない場合、現在の投稿が使用されます。
戻り値
- 成功した場合、タグオブジェクトの配列を返します。失敗した場合は
falseを返します。
関連する関数
使用可能なバージョン
- バージョン2.3.0以降に使用可能。
コアファイルのパス
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: 投稿のタグを表示する
<?php
$tags = get_the_tags();
if ($tags) {
foreach ($tags as $tag) {
echo $tag->name . ' ';
}
}
?>
このコードは、現在の投稿に付けられたタグを取得し、それを表示します。例えば、ブログ投稿の最後にタグを表示するために使えます。引用元: https://developer.wordpress.org/reference/functions/get_the_tags/
サンプル2: 特定の投稿IDのタグを取得する
<?php
$post_id = 42; // 取得したい投稿のID
$tags = get_the_tags($post_id);
if ($tags) {
foreach ($tags as $tag) {
echo $tag->name . ' ';
}
}
?>
このコードは、特定の投稿ID(この例では42)のタグを取得して表示します。特定の投稿に関連する情報を扱うときに有効です。引用元: https://developer.wordpress.org/reference/functions/get_the_tags/
サンプル3: タグのリンクを生成する
<?php
$tags = get_the_tags();
if ($tags) {
foreach ($tags as $tag) {
echo '<a href="' . get_tag_link($tag->term_id) . '">' . $tag->name . '</a> ';
}
}
?>
このコードは、現在の投稿のタグをリンク付きで表示します。ユーザーがタグをクリックすることで、そのタグのアーカイブページに移動できるようになります。引用元: https://developer.wordpress.org/reference/functions/get_the_tags/
サンプル4: タグの数をカウントする
<?php
$tags = get_the_tags();
$tag_count = is_array($tags) ? count($tags) : 0;
echo "この投稿には " . $tag_count . " 個のタグがあります。";
?>
このコードは、現在の投稿に付けられたタグの数をカウントして表示します。分析や表示の際に役立ちます。引用元: https://developer.wordpress.org/reference/functions/get_the_tags/
サンプル5: タグがない場合の処理
<?php
$tags = get_the_tags();
if ($tags) {
echo 'タグ: ';
foreach ($tags as $tag) {
echo $tag->name . ' ';
}
} else {
echo 'この投稿にはタグがありません。';
}
?>
このコードは、現在の投稿にタグがあるかどうかをチェックし、なければその旨を表示します。投稿にタグがない場合のユーザー体験を向上させるための工夫です。引用元: https://developer.wordpress.org/reference/functions/get_the_tags/