説明
array get_body_class( [ string $class = '' ] )
bodyタグのclass属性値を取得する。
パラメータ
- $classclass属性として追加するクラス名の文字列またはその配列
返り値
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
関連
お勧め
ブロックエディターの色設定を変えてみる（2019年12月11日 更新）
バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。
「姓」の後に「名」を（2013年11月6日 更新）
WordPressのユーザー情報設定ページでは、「名（First name）」の後に「姓（Last name）」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。
ホームディレクトリから過去のファイルを削除する（2013年1月27日 更新）
WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。Login rebuilder 2.6.5の新機能紹介（2021年3月8日 更新）
今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。
投稿情報を連想配列で参照する（2018年5月27日 更新）
投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。