カスタム投稿のタクソノミーで設定したタームをsingle.phpのbody_classに追加表示する方法

2022 6/21

2022年6月21日

実際に使用した商品をレビューしています。アフィリエイト広告リンクを含みます。

初心者

single.phpのbodyにタームのクラス属性を表示したい。
body_classにタクソノミーのタームスラッグを追加するカスタマイズを教えてほしい..

そんな人向けの記事です。

body_classテンプレートタグを使っているテーマの場合、bodyにページ属性が出力されますよね？。ただしWordPressの標準仕様でsingle.phpにタクソノミーのターム名は表示されません。

この記事ではsingle.phpのbody_classにカスタム投稿のタームスラッグを表示する方法を紹介します。

この記事を書いた人

IT業界24年のベテランエンジニア
WordPressで企業サイトの構築しています
取り扱いWordPressテーマは300個オーバー

SWELLマニアのかんたです

【body_class】single.phpのbodyにタームスラッグを表示する方法

single.php上のbody_classにターム情報を含めるには以下のコードをテーマのfunctions.phpに追加しましょう。

サンプルコード

add_filter( 'body_class', 'add_taxonomy_class' );
function add_taxonomy_class( $classes ){
    if( is_singular() ) {
        global $post;
        $taxonomy_terms = get_the_terms($post->ID, 'genre'); // タクソノミーを指定
        if ( $taxonomy_terms ) {
            foreach ( $taxonomy_terms as $taxonomy_term ) {
            $classes[] = 'term-'. $taxonomy_term->slug;
            }
        }
    }
    return $classes;
}

サンプルコードの「タクソノミーを指定」の部分に表示したいタクソノミースラッグを記述しましょう。

タクソノミーが「test」の場合は次のように記述します。

add_filter( 'body_class', 'add_taxonomy_class' );
function add_taxonomy_class( $classes ){
    if( is_singular() ) {
        global $post;
        $taxonomy_terms = get_the_terms($post->ID, 'test'); // タクソノミーを指定
        if ( $taxonomy_terms ) {
            foreach ( $taxonomy_terms as $taxonomy_term ) {
            $classes[] = 'term-'. $taxonomy_term->slug;
            }
        }
    }
    return $classes;
}

サンプルのコードを使うとbody_wrapにterm-タームスラッグ名の形式でクラス属性が追加されます。「term-**」の部分はサンプルコードの8行目で決めています。任意の文字列に変更可能です。

かんた

サンプルコードを使うと、下記の表のようにタームスラッグがsingle.phpに表示されるようになります↓

「ジャンル」タクソノミーのターム