[WordPress]カスタムタクソノミーに親子関係（階層）を持たせ、複数選択したタームの並び順を親＞子の順番に表示する

タクソノミーの設定

function add_custom_taxonomies() {
    register_taxonomy(
        'food', /* タクソノミー名。例では[food]とします */
        'post', /*　例では通常の投稿タイプを使います */
        array(
            'public' => true,
            'show_ui' => true,
            'hierarchical' => true, /* trueで階層を持つ */
            'label' => '食べ物',
            'query_var' => true,
            'rewrite' => true
        )
    );
}
add_action('init', 'add_custom_taxonomies', 0);

WordPressの標準の関数だけだと、複数選択したタームの[親＞子]表示は出来ない？

こんな単純そうなことが、タクソノミーを使って実装しようと思うと意外と出来ない…！get_termsやget_the_term_listを使えば、指定したタクソノミーのタームを取得することができますが、そもそもこれらの関数には親と子を順番に並べて出力する仕様がありません。

たとえば、親と子が1:1ずつだったり、選択する親が1つのみという規則があれば色々とやりようがあるようなのですが、今回の仕様は親も子も複数選択されている場合の想定なので、Wordpressの既存の関数のみではなかなかうまくいきません…。

DBから値を引っ張り出して配列を作る

既存の関数だとこれ以上どうしようもないので、DBの値を使用します。wp_term_taxonomyテーブルのparentが親子関係を見るフィールドなので、それぞれのカテゴリidに紐づくparent値（親カテゴリid値）を配列に組み込みます。

コード

functions.phpにメソッドを追加

function getRootTaxonomies($terms=null){
  $rootterms = array();
  if(isset($terms))
  {
    foreach($terms as $k=>$v){
      if($v->parent === 0){
          $v->children = array();
          $rootterms[] = $v;
      }
    }
    foreach($rootterms as $k=>$v)
    {
      foreach($terms as $sk=>$sv){
        if( $v->term_id === $sv->parent){
          $rootterms[$k]->children[] = $sv;
        }
      }
    }
  }
  return $rootterms;
}

親に子が紐づく形で配列を返します。子は親のchildrenの中に格納されます。

タームの親子関係を表示したい場所（single.php等のループ内・外）に追加

<?php
	$parents = getRootTaxonomies( get_the_terms( $post->ID,"food"), "0" );
	foreach($parents as $pv){
		echo "<ul>\n";
		echo '<li><a href="/food/'.$pv->slug.'">'.$pv->name.'</a></li>'."\n";
		echo "<li><ul>\n";
		foreach($pv->children as $ck=>$cv){
			echo '<li><a
			href="/food/'.$cv->slug.'">'.$cv->name.'</a></li>'."\n";
		}
	echo "</ul></li>\n";
	echo "</ul>\n";
	}
?>

get_the_terms_listのようにリンクを自動で生成しないので、echoに必要な要素を記述する必要があります。上記のサンプルはulの入れ子になるようになっています。
タームの各リンクは、タームのスラッグを元に構成します。taxonomyへのパーマリンクにarchivesなどのディレクトリ以下に設定している場合は、/food/となっている部分を/archives/food/と頭から記述する必要があるので注意してください。
なお、各タームへのアーカイブリンクが必要ない場合は各aタグを削除すればOKです。

パラメータの並び替え引数の確認

試しにwp_list_categoriesのCODEXを覗いてみると、並び替えの方法昇順、降順、ID名、名前…と色々ありますが、簡単に好きな順に並び替え出来る方法はありません。

スラッグの先頭に数字を付けて好きな順番に並べる方法もありますが、数が多ければ多いほど面倒ですし、今後のことを考えるとプラグインを使用するのが賢明かなと思います。

プラグイン

以下のプラグインを入れると、MovableTypeのカテゴリのようにドラッグアンドドロップで好きなように入れ替えできるのでオススメ。よく使用する2つをご紹介します。

• PS Taxonomy Expander
• Category Order and Taxonomy Terms Order

両方共、カテゴリー・タームの順番を変更出来ます。PS Taxonomy Expanderはそれ意外にも機能がありますので、どちらを使うかはケースバイケースで。

プラグインで設定した並び順通りにカテゴリー／タームを反映させたい

プラグインで並び替えを設定しているのに、投稿記事を見てみるとうまく反映されてないと思います。そんな時は以下のコードをfunctions.phpに追記します。

function terms($a, $b){
	if ( intval($a->term_order) == intval($b->term_order)) {
	    return 0;
	}
	return (intval($a->term_order) < intval($b->term_order)) ? -1 : 1;
}
function terms_sort($terms, $object_ids, $taxonomies, $args){
	if(!is_admin()){
		usort($terms , "terms");
	}
	return $terms;
}
add_filter('wp_get_object_terms','terms_sort',99,4);

コード参照元：gist:5625795 tkc49 GitHub

上記コードでは何をしてるかというと、上記で説明したプラグインを有効化するとtermsテーブルにterm_orderというカラムが作成されます。
wp_get_object_termsフィルターで取得したtermsの中に上記プラグインで追加されたterm_orderの値が取得できるので、その値を使ってPHP側でソートをしています。

【WordPress】記事に設定したカスタムタクソノミーのタームの並び順を好きな並び順にする方法

get_the_termsには並び替えの引数がなく、wp_get_post_termsの引数で制御してもうまく並び替えが出来なかったため、大変助かりました。