概要
get_tag_link関数は、WordPressにおいて特定のタグに関連するリンク文字列を取得するための機能を提供します。この関数は主に、ユーザーが生成するコンテンツでタグを表示し、クリック時にそのタグに関連する投稿を表示できるようにする際に使用されます。具体的には、以下のような場面で役立ちます：
- タグクラウドを作成する。
- 投稿内でタグリンクを表示する。
- カスタムウィジェットでタグを表示する。
- タグベースのナビゲーションを構築する。
- 投稿ごとのタグ一覧を生成する。
- アーカイブページでタグリンクを表示する。
- タグ関連のSEO対策を行う。
- タグページのデザインをカスタマイズする。
この関数は以下の構文で使用されます：
get_tag_link( int $tag_id )
パラメータ
tag_id(int): リンクを取得するタグのID。このパラメータは必須です。
戻り値
取得したタグリンクのURL文字列を返します。指定されたタグが存在しない場合は、falseを返します。
関連する関数
使用可能バージョン
get_tag_linkはWordPressのバージョン2.0以降で使用可能です。
コアファイルのパス
get_tag_link関数は、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: タグのリンクを表示
このコードは、特定のタグIDのリンクを取得し、HTMLのアンカータグとして出力します。
$tag_id = 5; // タグID
$tag_link = get_tag_link($tag_id);
if ($tag_link) {
echo '<a href="' . esc_url($tag_link) . '">タグ名</a>';
}
このコードは、指定されたID（5）のタグリンクを取得し、それをアンカータグとして表示します。
サンプルコード2: タグアーカイブのリンクを作成
このコードは、投稿のタグを取得し、それぞれのタグについてリンクを表示します。
$post_tags = get_the_tags();
if ($post_tags) {
foreach ($post_tags as $tag) {
echo '<a href="' . esc_url(get_tag_link($tag->term_id)) . '">' . esc_html($tag->name) . '</a> ';
}
}
このコードでは、現在の投稿に関連する全てのタグのリンクを生成し、それぞれのタグ名をリンクとして表示します。
サンプルコード3: タグリンクをリスト化
このコードは、全てのタグリンクをリスト形式で表示します。
$tags = get_tags();
echo '<ul>';
foreach ($tags as $tag) {
echo '<li><a href="' . esc_url(get_tag_link($tag->term_id)) . '">' . esc_html($tag->name) . '</a></li>';
}
echo '</ul>';
全てのタグを取得し、リスト形式で各タグのリンクを表示するサンプルコードです。
サンプルコード4: タグリンクをボタンとして表示
タグのリンクをボタン形式で表示するコードです。
$tag_id = 10; // タグID
$tag_link = get_tag_link($tag_id);
if ($tag_link) {
echo '<a href="' . esc_url($tag_link) . '" class="button">タグ名</a>';
}
このコードは、特定のタグについてのリンクをボタンスタイルで表示します。
サンプルコード5: タグリンクのカスタマイズ
このコードは、特定の条件に応じてタグリンクをカスタマイズします。
$tag_id = 15; // タグID
$tag_link = get_tag_link($tag_id);
if ($tag_link) {
$custom_title = 'Visit Tag'; // カスタムタイトル
echo '<a href="' . esc_url($tag_link) . '" title="' . esc_attr($custom_title) . '">' . esc_html($custom_title) . '</a>';
}
特定のタグIDのリンクを取得し、カスタムタイトルを使って表示するサンプルコードです。