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



お勧め

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

WordPressのコーディングスタンダードとPSR-2がかみ合わない(2018年5月27日 更新)

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon(4.6)」から「Oxygen(4.7)」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style(Formatter)」が「PSR-2」に設定されていることが原因だった。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

さくらのVPSでKUSANAGI#3(2018年5月27日 更新)

今回は「前回」の続き。http(80番)をクローズ、そのほかに行った調整作業について整理する。