get_body_class

(2.8.0以降)
get_body_class - 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

関連

  • body_class - bodyタグのclass属性を表示する

お勧めコンテンツ

テーマから投稿画像のサイズを指定する(2012年3月15日 登録)

投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

カスタム投稿タイプの投稿保存には専用アクションを使おう(2014年7月4日 登録)

カスタム投稿タイプを登録して、専用ウィジェット(meta_box)を使って拡張情報を入力させ、それらの情報をsave_postアクションで保存する。これまではこんな感じだったのだが、久しぶりにカスタム投稿タイプを使ったら、save_postアクションの前にsave_postに投稿タイプ名がくっついたアクションが追加されていた。

管理者ページに文言を表示する(2012年4月19日 登録)

お客様向けに管理者ページをカスタマイズする機会が増えてきている。カスタマイズするページや表示場所、表示内容によっていくつかの手段があるが、今回はページの冒頭部分に任意の文言を表示する方法を紹介する。

4.2の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2015年5月13日 登録)

ダッシュボードの「アクティビティ」ウィジェットは「投稿(post)」の状況を表示し、固定ページ(page)やカスタム投稿タイプの投稿記事の状況については標準では表示されない。このことに対して以前『3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する』を紹介したのだが、4.2では新しいフィルターが追加され、カスタマイズが少し容易になった。

管理画面でツールバー(Admin bar)を非表示にする(2013年3月5日 登録)

WordPress使ってちょっと変わったサイトを構築する際、管理画面のツールバーを表示させたくないケースがある。一般に公開するサイト側であれば、show_admin_bar関数で非表示にできるのだが、管理画面ではこれを使ってもツールバーは消えてくれない。

最終更新日時 : 2012-06-23 16:01