get_term_link() の使い方|説明・引数・注意点

説明

get_term_link() は、ターム(カテゴリー、タグ、カスタムタクソノミー)のアーカイブURLを返す関数です。

基本構文

get_term_link( WP_Term|int|string $term, string $taxonomy = '' ): string|WP_Error

引数

  • $term:ターム(オブジェクト、ID、スラッグ)
  • $taxonomy:タクソノミー名(ID・スラッグ指定時に必須)

戻り値

URL。失敗時は WP_Error。

使い方(サンプル)

$link = get_term_link( 'rock', 'genre' );
if ( ! is_wp_error( $link ) ) {
	echo esc_url( $link );
}

注意点

  • WP_Error が返ることがあるため、is_wp_error() で確認してから使います。

実務での使いどころ

  • カスタムタクソノミーの、タームのアーカイブへのリンクを作るとき。
  • get_the_terms() で取得したタームを、リンク付きで出力するとき。

よくあるミスと対処

  • 戻り値が WP_Error の場合がある。確認せずに出力する。
  • スラッグで渡すとき、第2引数にタクソノミーを指定していない。

NG例

echo get_term_link( 'important' ); // タクソノミーが分からず、取得できない

OK例

$link = get_term_link( 'important', 'news_cat' );
if ( ! is_wp_error( $link ) ) {
	echo esc_url( $link );
}

使い分け早見表

関数 返すURL
get_term_link() 任意のタクソノミーのタームのアーカイブのURL
get_category_link() カテゴリーのアーカイブのURL
get_tag_link() タグのアーカイブのURL

関連項目

get_category_link()、get_the_terms()

公式リファレンス:get_term_link() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました