get_the_term_list

（2.5.0以降）
get_the_term_list - 投稿のタームのリンク文字列を取得する

説明

string | false get_the_term_list( int $post_id, string $taxonomy [ , string $before = '' [ , string $sep = ', ' [ , string $after = '' ] ] ] )
投稿のタームのリンク文字列を取得する。

パラメータ

  • $post_id
    投稿IDを指定。
  • $taxonomy
    タクソノミー名を指定。
  • $before
    最初のタームの前に表示する文字列を指定（省略時は''）。
  • $sep
    タームとタームの間に入る区切り文字列を指定（省略時は''）。
  • $after
    最後のタームの後に表示する文字列を指定（省略時は''）。

返り値

投稿のタームのリンク文字列を返す。タームを取得できなかった場合はfalseまたはWP_Errorオブジェクトを返す。

注意

get_the_terms関数により、投稿のタームを取得している。

パラメータ$sepの省略時の値は''になり、 the_terms関数とは異なる。

タームのリンク文字列は次のような書式となる。

<a href="タームのURL" rel="tag">ターム名</a>

使用例

  • 投稿タグのリンク文字列を取得する。
    $links = get_the_term_list( $post->ID, 'post-tag' );
  • 区切り文字を指定して投稿タグのリンク文字列を取得する。
    $links = get_the_term_list( $post->ID, 'post-tag', '', '、' );

フィルター

[2.5.0]タームのリンク文字列を連結する前に"term_links-{$taxonomy}"フィルターを呼び出す。パラメータ$linksにはタームのリンク文字列の配列が格納されている。 
$term_links = apply_filters( "term_links-{$taxonomy}", $links );

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/category-template.php

最終更新 : 2023年07月28日 11:33

関連

参考

Code Reference: get_the_term_list

お勧め

Login rebuilder 2.3.0の新機能を紹介（2018年5月27日 更新）

プラグイン「Login rebuilder」はログイン時の履歴（ログ）や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。

古めのリビジョンを削除した時のメモ（2022年5月16日 更新）

大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。

決まった値を返すだけの関数群（2018年5月27日 更新）

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

「Align widgets horizontally」プラグインのフィルター使用例（2024年5月15日 更新）

ダッシュボードのウィジェットを横並びに変える「Align widgets horizontally」プラグインには緒設定を変更できるフィルターが用意されている。ここではフィルターの使い方と設定できる項目について紹介する。

WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。