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



お勧め

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

4.2で始まるiOSの絵文字ケア(2018年5月27日 更新)

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている(基本的にはiOSの)絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

「不明な書式」って何ですか。(2024年11月13日 更新)

オートコンプリート機能を利用して四字熟語を挿入するプラグインを作った際、ツールバーに「不明な書式をクリア(Clear Unknown Formatting)」ボタンが表示されるようになった。この「書式」、何を指しているのかわからないんだが。

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

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