WEB制作のための情報サイト / unazuki Library

基本構文と使い方（引数・実行結果）

基本構文

条件にマッチしたタームオブジェクトの配列を取得します。タームの一覧を表示したいときなどに使うことができます。

get_terms($args,$deprecated);

get_terms($args,$deprecated);

引数

プラグインでカスタマイズしている場合は、プラグインが優先される可能性があります。例えば、orderbyやorderの値が反映されない場合は、ターム並び替えのプラグインが効いている可能性を疑ってみてください。

実行結果

戻り値（返す値）：条件にマッチしたタームオブジェクトの配列
取得したタームオブジェクトを配列として返します。foreachでループを回して配列から１つ１つ要素（タームのオブジェクト）を取り出してタームの名前を取得したりすることができます。
このオブジェクトが持つ主なプロパティ（中身）は以下の通りです。

例１．条件指定と必要情報の表示例

下記例では、まずタクソノミー「example-taxonomy」に所属するタームからID10と12のタームを除外し、さらにいくつか条件を加えた上でタームの一覧を取得しています。そして取得したターム一覧をforeachで回し、各タームオブジェクトからタームの名前を取得・表示してタームIDと名前の一覧表示を作成します。

<?php
$args = [
	'taxonomy' => 'example-category', // 複数の場合は配列指定可
	'exclude' => [10, 12], // ID10と12のタームを除外
	'orderby' => 'count', // 表示する際の順番をcount（記事数）を基準にする
	'order' => 'DESC', // 表示順を降順（この場合、記事件数が多い順）にする
	'hide_empty' => false, // 記事件数が0のタームも含める
];
$terms = get_terms($args);
foreach ($terms as $term) { // 配列から１つ１つ要素（タームオブジェクト）を取り出して処理
	echo $term->term_id; // タームのIDを取得して表示
	echo $term->name; // タームの名前を取得して表示
}
?>

<?php
$args = [
	'taxonomy' => 'example-category', // 複数の場合は配列指定可
	'exclude' => [10, 12], // ID10と12のタームを除外
	'orderby' => 'count', // 表示する際の順番をcount（記事数）を基準にする
	'order' => 'DESC', // 表示順を降順（この場合、記事件数が多い順）にする
	'hide_empty' => false, // 記事件数が0のタームも含める
];
$terms = get_terms($args);
foreach ($terms as $term) { // 配列から１つ１つ要素（タームオブジェクト）を取り出して処理
	echo $term->term_id; // タームのIDを取得して表示
	echo $term->name; // タームの名前を取得して表示
}
?>

学習者向け補足情報

よくある使い方

ニュースやブログページのサイドバーに任意のタクソノミーに所属するターム一覧を表示したい場合などで使われます。具体的なコードは下記「参考コード」を参考にしてください。

参考コード

下記例では、指定したタクソノミーに紐づくタームの一覧をリンク付きで表示します。
取得した配列（タームオブジェクトの配列）からループ処理でタームオブジェクトを取り出し、そのオブジェクトから必要情報を取得してHTMLに埋め込んでいます。
下記コードにあるget_term_link()はタームオブジェクトを引数にとり、タームのリンク（タームに紐づく記事の一覧を表示するためのリンク）を返します。

<?php
$args = [
	'taxonomy'   => 'example-category',
	'orderby'    => 'count',
	'order'      => 'DESC',
];
$terms = get_terms($args);

if (!empty($terms) && !is_wp_error($terms)) { // 空の配列あるいはエラーではないか
	echo '<ul>';
	foreach ($terms as $term) {
		echo '<li>';
		echo '<a href="' . get_term_link($term) . '">';
		echo $term->name;
		echo '</a> (' . $term->count . ')';
		echo '</li>';
	}
	echo '</ul>';
}
?>

<?php
$args = [
	'taxonomy'   => 'example-category',
	'orderby'    => 'count',
	'order'      => 'DESC',
];
$terms = get_terms($args);

if (!empty($terms) && !is_wp_error($terms)) { // 空の配列あるいはエラーではないか
	echo '<ul>';
	foreach ($terms as $term) {
		echo '<li>';
		echo '<a href="' . get_term_link($term) . '">';
		echo $term->name;
		echo '</a> (' . $term->count . ')';
		echo '</li>';
	}
	echo '</ul>';
}
?>

結果例：下記のようにターム一覧を記事数付きで表示します（実際にはリンクが付きます）。
カテゴリーA(11)
カテゴリーB(5)
カテゴリーC(3)
カテゴリーD(1)

関連するテンプレートタグ