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



お勧め

ログアウト後はいつもサイトトップ(2018年5月27日 更新)

ログアウト後に表示(リダイレクト)されるページは、標準ではログインページ(wp-login.php)である。4.2.0ではログアウト処理後のページリダイレクト前に呼び出されるフィルターが追加された。

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

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

oEmbed対応サイトを整理した(2017年11月18日 更新)

投稿記事にTwitterやYouTubeのURL(アドレス)を記述したとき、表示されるページにはリンクとしてではなく、埋め込んだURLの内容が表示される。この仕組み(機能)はoEmbedというもので、対応サイトは随時バージョンアップしている。

投稿内容に応じてwpautopを制御する(2013年8月13日 更新)

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。

Login rebuilder:プラグイン作ってみました(2019年9月7日 更新)

昨年投稿した「ログインページを変える」をプラグイン化。ログインページを独自の名前のページ変更し、標準のログインページwp-login.phpを使用できないようにするプラグインです。部外者によるwp-login.phpのアクセスにお悩みの方にお勧めします。また2.0.0では「XML-RPCリクエストの管理機能」を追加。2.2.0では管理者のログイン時にメールで通知する機能を追加しました。