WordPressのget_the_categoryの取得順をカスタマイズする

WordPressで投稿記事が属するカテゴリーを取得する get_the_category は、属するカテゴリーをカテゴリーの名前順で取得してきます。これは、カテゴリーだけでなく、投稿タグの get_the_tags やカスタム分類での get_the_terms でも同様です。

しかしながら、利用シーンによっては名前以外の順序で取得したい場合もあるのではないでしょうか。今回は、この取得順序を指定できる方法を紹介してみたいと思います。

この記事は、jim912によって書かれたものです。
引用を行う場合は、著作権法に定める範囲にて、引用元であるSimple Colorsの出展元表示とhttp://www.warna.info/archives/1816/へのリンクを必ず行って下さい。

やり方はいろいろあって、

  1. get_the_terms のフックを利用する方法
  2. wp_get_object_terms 関数で orderby パラメータを指定する方法

などもありますが、今回は単純ながらデフォルト取得結果を特定の値で再ソートする方法を採りたいと思います。

というのも、1では引数が自由に取れず特定のカスタマイズしか出来ないこと、2では使う毎にデータベースクエリーが発生するため、多用するとパフォーマンスへの影響が大きくなること、return される値が配列以外に真偽値/オブジェクトの可能性があり対応が多岐になりかねないことによるものです。

それに引き替え、再ソートの方法では、パラメータによって自由なソートが可能、オブジェクトキャッシュに対応しているので、多用してもパフォーマンスへの影響がごく僅かに抑えられる、デフォルトの取得結果は配列に統一されていることなど、他の方法と比較してデメリットが少ないことが挙げられます。

具体的な方針としては、

  1. 指定可能なパラメータとして、記事のID、ソート用の項目、昇順/降順指定、タクソノミー
  2. パラメータには、それぞれ初期値を与え、パラメータの指定が無い場合でも動作するようにする
  3. 取得用の内部関数として get_the_terms を使う
  4. ソート用項目をキーとしたソート用の連想配列を生成し、ksort/krsort関数で再ソートをかける

といった実装になります。

CODE 1 を functions.phpなどに追加して、取得時に get_ordered_terms を使用すれば、ソート済みの結果を得ることができます。

CODE 1

function get_ordered_terms( $id = 0, $orderby = 'term_id', $order = 'ASC', $taxonomy = 'category' ) {
	$terms = get_the_terms( $id, $taxonomy );
	if ( $terms ) {
		$ordered = array();
		foreach ( $terms as $term ) {
			if ( isset( $term->$orderby ) ) {
				$ordered[$term->$orderby] = $term;
			}
		}
		if ( strtoupper( $order ) == 'DESC' ) {
			$func = 'krsort';
		} else {
			$func = 'ksort';
		}
		$func( $ordered );
		return $ordered;
	}
}

記述例:記事の属するカテゴリーをid順に取得

$terms = get_ordered_terms();

記述例:表示中の記事の属するカテゴリーを属する記事の多い順に取得

$terms = get_ordered_terms( 0, 'count', 'DESC' );

記述例:記事IDが238の属する投稿タグをスラッグ順に取得

$terms = get_ordered_terms( 238, 'slug', 'ASC', 'post_tag' );
カテゴリー: WordPressの小技 タグ: , , , , パーマリンク

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です