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



お勧め

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(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_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。