ワードプレスのthe_tags関数の使用方法・解説

概要

the_tags関数は、リンク付きの投稿タグを表示するために使用されるWordPressの関数です。この関数は、特定の投稿に関連付けられたタグをリストとして出力し、各タグはそのタグに関連する投稿のアーカイブページへのリンクとして表示されます。この関数は、特に以下のような機能を実装する際に役立ちます。

1. 投稿に関連するタグを表示する。
2. カスタム投稿タイプにおけるタグの表示を行う。
3. タグクラウドを使用しないシンプルなタグ表示。
4. タグをクリックすることで関連した投稿を参照できるようにする。
5. タグの表示スタイルをカスタマイズする。
6. SEO対策としてタグの重複を回避するための表示。
7. 投稿情報の一部としてタグを視覚的に強調する。
8. テーマ等においてタグ関連のカスタマイズを行う際のサポート。

構文

the_tags( $before, $sep, $after );

パラメータ

• $before (string) – (任意) タグの前に表示する文字列。デフォルトは空。
• $sep (string) – (任意) タグ間の区切り文字列。デフォルトはカンマとスペース。
• $after (string) – (任意) タグの後に表示する文字列。デフォルトは空。

戻り値

この関数は、投稿タグを表示するだけで、値を返しません。

関連する関数

• get_the_tags
• wp_tag_cloud
• has_tag
• the_taxonomies

使用可能なバージョン

the_tags関数は、WordPress 2.3以降で利用可能です。

コアファイルのパス

the_tags関数は、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 ( have_posts() ) {
      while ( have_posts() ) {
          the_post();
          the_tags('<p>タグ: ', ', ', '</p>');
      }
   }
   

   このコードは、投稿が存在する場合、それぞれの投稿に対してタグを表示します。

2. カスタム区切りでのタグ表示

   if ( have_posts() ) {
      while ( have_posts() ) {
          the_post();
          the_tags('<p>関連タグ: ', ' | ', '</p>');
      }
   }
   

   このコードでは、タグ間の区切りを「|」に設定して表示します。

3. タグの前後にマークアップを追加

   if ( have_posts() ) {
      while ( have_posts() ) {
          the_post();
          the_tags('<span class="tag">', '</span>', ' ');
      }
   }
   

   タグを<span>タグで囲み、特定のスタイルを適用可能にします。

4. タグの無効化条件の設定

   if ( has_tag() ) {
      the_tags('<p>使用されているタグ: ', ', ', '</p>');
   }
   

   このコードは、投稿にタグが存在する場合のみ、それを表示します。

5. 出力のスタイリングの簡単な例

   if ( have_posts() ) {
      while ( have_posts() ) {
          the_post();
          echo '<div class="tags-container">';
          the_tags('<span class="tag-item">', '</span> ', '');
          echo '</div>';
      }
   }
   

   タグをスパンタグで括り、クラスを追加してスタイリングが可能です。

すべてのサンプルコードは、特定の著作権の制約のない例を基に作成されています。