get_post_class

説明

array get_post_class( [ mixed $class = '' [ , int $post_id = null ] ] )
投稿記事のクラス名を取得する。

パラメータ

  • $class
    追加するクラス名を文字列まはた配列で指定(省略時は'')。
  • $post_id
    対象となる投稿情報のIDを指定(省略時はnull)。

返り値

クラス名を含んだ配列を返す。

注意

クラス名は esc_attr関数で属性値として無効な文字は取り除かれる。

クラス名としては、'post-{ID}'、'type-{投稿タイプ名}'、'status-{投稿ステータス}'、'format-{投稿フォーマット名}'、'hentry'、'category-{カテゴリーのスラッグまたはID}'、'tag-{投稿タグのスラッグまたはID}'など。

[4.2.0]カスタムタクソノミーが'{カスタムタクソノミー名}-{そのスラッグまたはID}'の形式で追加されるようになった。

[6.1.0]'post_class_taxonomies'フィルターが追加され、クラス名として含めたくないタクソノミーがある場合にはこのフィルターで除外できる。


使用例

  • 現在の投稿情報のクラス名を取得する。
    <?php $classes = get_post_class(); ?>
  • 現在の投稿情報のクラス名に'topic'を追加して取得する。。
    <?php $classes = get_post_class( 'topic' ); ?>
  • IDが2014の投稿情報のクラス名を取得する。。
    <?php $classes = get_post_class( '', 2014 ); ?>

フィルター

[6.1.0]カスタムタクソノミーのクラス名を追加する前に'post_class_taxonomies'フィルターを呼び出す。パラメータ$taxonomiesにはパブリックなタクソノミーの配列が、$post_IDには実際の投稿情報のID値が、$classesにはその時点のクラス名を格納した配列が、$classには本関数が受け取った内容が格納されている。
$taxonomies = apply_filters( 'post_class_taxonomies', $taxonomies, $post_ID, $classes, $class );
[2.7.0]クラス名を含んだ配列を返す直前に'post_class'フィルターを呼び出す。パラメータ$classesにはクラス名の配列が、$classには本関数が受け取った値、$post_IDは実際の投稿情報のID値となる。
return apply_filters( 'post_class', $classes, $class, $post_ID );

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/post-template.php

最終更新 : 2022年11月06日 16:58



お勧め

カレンダーウィジェットをAjaxで切り替える(2011年8月22日 更新)

ウィジェットベースでテーマを構築していてカレンダーを表示してみた。標準では、前月や次月のリンク先はそれぞれの月のアーカイブページとなっているのだが、記事を探すだけであればカレンダー部分だけを更新するほうが便利なのではと考え、そのアイデアを実装してみた。

3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2014年1月17日 更新)

ちょうど1月前の「ダッシュボードの「概要」にカスタム投稿タイプ件数を表示する」にて、WordPress 3.8新ダッシュボードの「概要」ウィジェットにカスタム投稿タイプの投稿数を表示する方法を紹介したが、今回のその続編で「アクティビティ」ウィジェットを拡張する方法を紹介する。

5.5の機能強化:コメントフォームのちょっとした改良(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2、3と公開が続いている。「WordPress 5.5 Beta 3(以降Beta 3)」のソースコードを見ていくと、コメントフォームを表示する comment_form関数が機能拡張されていた。

5.3への準備:投稿写真を使っているサイトは準備しておこう(2019年10月10日 更新)

この記事は先日公開した「5.3の新機能:JPEG画像の向きを調整」の続きのようなものになる。高解像度の投稿写真を扱っているサイトは、5.3のリリースに合わせて対応を検討しておくべきことをまとめてみた。

画像ブロックに効果を追加した時にハマった(2023年3月30日 更新)

画像ブロックに対して見た目が変わる効果を追加しようと思い機能拡張してみた。その際、いくつかの効果は問題なかったのだが、1つの効果だけその画像を選択したときのみ効果が消える不具合が発生。対処内容はシンプルなものだが、忘れないようにメモっとく。