get_body_class

説明

array get_body_class( [ string $class = '' ] )
bodyタグのclass属性値を取得する。

パラメータ

  • $class
    class属性として追加するクラス名の文字列またはその配列

返り値

class属性値を含んだ配列を返す。
ページタイプ別の配列の内容は、おおよそ次の通り。
ページタイプ(テーマ内ファイル名)戻り値
ホーム(index.php){ 'home', 'blog' }
日付別アーカイブ
(archive.php, date.php)
{ 'archive', 'date' }
カテゴリー別アーカイブ
(archive.php, category.php)
{ 'archive', 'category', 'category-1' }
※「1」の部分にはカテゴリーのスラッグが入る。
タグ別アーカイブ
(archive.php, tag.php)
{ 'archive', 'tag', 'tag-mini' }
※「mini」の部分にはタグのスラッグが入る。
著者別アーカイブ
(archive.php, author.php)
{ archive author author-admin }
※「admin」の部分には著者名が入る。
投稿(single.php){ 'single', 'single-post', 'postid-152' }
※「152」の部分には投稿情報IDが入る。
ページ(page.php){ 'page', 'page-id-2', 'page-template', 'page-template-default' }
※「2」の部分には投稿情報IDが入る。
検索結果ページ(search.php){ 'search', 'search-results' }
404ページ(404.php){ 'error404' }
ログイン時(共通)配列に'logged-in'が含まれる

注意

特にありません。

使用例

  • bodyタグのclass属性値を取得する。
    <?php $class_arr = get_body_class( ); ?>

フィルター

クラス名の配列を返す直前にbody_classフィルターを実行する。パラメータ$classesにはクラス名の配列が、 パラメータ$classには本関数で受け取った内容が格納されている。
return apply_filters( 'body_class', $classes, $class );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/post-template.php

最終更新 : 2018年05月27日 10:52



お勧め

Login rebuilder 2.6.0の新機能紹介(2019年4月22日 更新)

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

query_posts(WP_Queryクラス)で投稿タグを絞り込む(2011年9月14日 更新)

投稿タグの絞り込みは、カテゴリーに似ているけど微妙に違っている。今日は、昨日投稿した「query_posts(WP_Queryクラス)でカテゴリーを絞り込む」の続きとして、投稿タグの絞り込みついてまとめてみる。

classic editorプラグインを試してみた(2018年12月10日 更新)

WordPress 5.0 beta1のリリースにあわせて旧エディター環境を実現できる「classic editor」(バージョン0.5.0)が公開された。自分が公開しているプラグインの一部が旧エディター環境に依存していることもあり、さっそく試してみた。WordPress 5.0正式リリースに合わせてclassic editorも1.0がリリースされたので、それについて追記しました。

コメントの「ウェブサイト」止めました(2014年4月15日 更新)

とあるサイトのスパムコメントが多く、その都度のスパム指定するのが面倒である。これまでいくつか対策を行ってきたが、そういった対応にもいい加減うんざりしてきたので、試験的に「ウェブサイト」を無効化しようと思った。

プラグインの設定ページもレスポンシブ対応(2014年6月3日 更新)

レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。