get_term_link

説明

string get_term_link( mixed $term [ , string $taxonomy = '' ] )
カテゴリーや投稿タグなどのタームのリンク文字列を取得する。

パラメータ

  • $term
    タームのIDかオブジェクトを指定。
  • $taxonomy
    'category'、'post_tag'などのタクソノミー名を指定(省略時は'')。

返り値

タームのリンク文字列を返す。パラメータ$termが無効な値の場合は、エラー内容を示すWP_Errorオブジェクトを返す。

注意

カテゴリーの場合のリンク文字列の書式は次の通り(1の部分にはそのカテゴリーのIDが入る)。
http://ドメイン名/?cat=1
投稿タグの場合のリンク文字列の書式は次の通り(slugの部分にはその投稿タグのスラッグが入る)。
http://ドメイン名/?tag=slug

[2.5.0]'term_link'フィルターが追加され、'tag_link'および'category_link'フィルターは非推奨となった。

[5.4.1]バージョン2.5.0で非推奨になっていた'tag_link'フィルターおよび'category_link'フィルターが復活した。


使用例

  • カテゴリーIDが1のリンク文字列を取得する。
    <?php $link = get_term_link( 1, 'category' ); ?>
  • 投稿タグIDが11のリンク文字列を取得する。
    <?php $link = get_term_link( 11, 'post_tag' ); ?>

フィルター

[4.9.0]パーマリンクを作成する前に'pre_term_link'フィルターを呼び出す。パラメータ$termlinkにはパーマリンクのパターン(例:標準のカテゴリーの場合は'/category/%category%')が、$termにはターム情報のオブジェクトが格納されている。
$termlink = apply_filters( 'pre_term_link', $termlink, $term );
[2.3.0][5.4.1]パラメータ$taxonomyが'post_tag'の場合は'term_link'フィルターを呼び出す前に'tag_link'フィルターを呼び出す。パラメータ$termlinkにはパーマリンクが、$term_idにはタームIDが格納されている。
$termlink = apply_filters( 'tag_link', $termlink, $term_id );
[1.5.0][5.4.1]パラメータ$taxonomyが'category'の場合は'term_link'フィルターを呼び出す前に'tag_link'フィルターを呼び出す。パラメータ$termlinkにはパーマリンクが、$term_idにはタームIDが格納されている。
$termlink = apply_filters( 'category_link', $termlink, $term_id );
[2.5.0]パーマリンクを返す前に'term_link'フィルターを呼び出す。パラメータ$termlinkにはパーマリンクが、$termにはターム情報のオブジェクトが、$taxonomyにはタームのタクソノミー名(例:'category')が格納されている。
return apply_filters( 'term_link', $termlink, $term, $taxonomy );

アクション

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

ソースファイル

/wp-includes/taxonomy.php

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



お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

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

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

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。