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



お勧め

5.3の新機能:クエリーログに任意の項目を追加できる新フィルター(2019年10月23日 更新)

5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。

Login rebuilder 2.7.4の変更内容を紹介(2022年7月6日 更新)

Login rebuilder 2.7.4では、ダッシュボードの「ログインのログ」ウィジェット内に現在のユーザー(管理者のみ)のログイン状況を簡潔なメッセージで表示するようにした。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。

プラグインの設定ページもレスポンシブ対応(2014年6月3日 更新)

レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。

oEmbed対応サイトを整理した(2023年8月9日 更新)

投稿記事にTwitterやYouTubeのURL(アドレス)を記述したとき、表示されるページにはリンクとしてではなく、埋め込んだURLの内容が表示される。この仕組み(機能)はoEmbedというもので、対応サイトは随時バージョンアップしている。