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

説明

body_class() は、body タグ用に、ページの種類を表すクラス名を出力する関数です。

基本構文

body_class( string|string[] $css_class = '' ): void

引数

  • $css_class:追加するクラス名

戻り値

戻り値はありません(出力します)。

使い方(サンプル)

// header.php の body タグ内で呼び出す
body_class( 'my-class' );

注意点

  • body タグの class 属性の中で呼び出します。
  • ページごとのスタイル指定に便利です。取得だけなら get_body_class()。

実務での使いどころ

  • <body> に、ページの種類ごとの、CSSのクラスを、付けるとき(home・single・page-id-12 など)。
  • 独自のクラスを、追加して、ページごとに、見た目を変えるとき。

よくあるミスと対処

  • class="..." の中で、呼んでいる。この関数は、class="..." 全体を、出力する。
  • クラスを、追加したいのに、直接書いている。引数や、body_class フィルターで、追加できる。
  • <body> に、この関数を、呼んでおらず、テーマのクラスが、付かない。

NG例

<body class="<?php body_class(); ?>"> <!-- class が二重になる -->

OK例

<body <?php body_class( 'my-theme' ); ?>>

使い分け早見表

関数 役割
body_class() <body> 用の、class="..." を、出力する
post_class() 投稿用の、class="..." を、出力する
get_body_class() クラスの配列を、返す

関連項目

post_class()、get_body_class()

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

コメント

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