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



お勧め

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クラスにより、その習慣とおさらばできるかもしれない。