説明
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
関連
お勧め
Contact Form 7に確認フェーズを(2012年12月16日 更新)
Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。Somewhere search box:プラグイン作ってみました(2021年4月26日 更新)
投稿済みの記事を修正する際、毎回「投稿一覧」に戻るのは面倒だ、そんなことを感じて作ったのがこのプラグインです。また1.2.0では投稿内容(本文、カテゴリーや投稿タグ、カスタムフィールド)を複製するリンクを投稿一覧ページと投稿編集ページに追加、1.3.0では投稿タイトルのみの検索をサポートしました。カスタムブロックを作っていると、ブロック自身の「サイズ」を指定するUIを持たせることがある。そんなときにちょっとモヤっとするのが、「マージン」や「パディング」の設定しているパネルのタイトルが「サイズ」なこと。この「サイズ」の原文は「Dimensions」であり、個人的にもう少しスッキリするワードに変更してみた。
決まった値を返すだけの関数群(2018年5月27日 更新)
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
5.7の新機能:AJAXでパスワードを取得(2021年2月17日 更新)
日本時間の今朝「WordPress 5.7 Beta 3(以降Beta 3)」が予定通り公開されました。今回は、ソースコードを眺めていた時に気になったパスワードを取得できるAJAXについて確認した。