説明
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
関連
お勧め
投稿記事でrubyタグを使えるようにする（前編）（2012年1月25日 更新）
rubyなどのルビ関連タグはIEの独自サポートから始まり、少し前のChrome/Safariが追随して利用できるようになっている。Firefoxはいまだにサポートしていないのだが、それなりに代替表示されるので、投稿記事で使えるようにしてみた。WordPressの鼓動（2013年10月1日 更新）
WordPressでは、Ajaxを利用する方法の1つとして add_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。
「順序」をtextからnumberに変更してみた（2018年5月27日 更新）
固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。
一定時間でログアウトする（2013年5月23日 更新）
ログイン関係を調べている関係で、 wp_set_auth_cookie関数に行き着く。ログイン画面の「ログイン状態を保持する」がチェックされた場合、クッキーの有効期限は14日間。チェックされていない場合は、ブラウザが閉じるまで常に有効となっているんだね。
5.3の機能強化：カスタムフィールドキーの条件指定が使いやすくなる（2019年11月19日 更新）
5.3 RC4もリリースされ、正式リリースまであと1週間。5.3の変更点を確認していると、WP_Meta_Queryクラスが変更されていた。これは「Expanded meta key comparison operators in 5.3」で紹介されており、さまざまな条件指定が追加されていた。