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



お勧め

CSSやJavaScriptファイルのバージョン番号を変える(2018年5月27日 更新)

WordPress 4.7系の脆弱性をついた攻撃も落ち着いた感じなので、標準でヘッダーやフッター内に出力されるWordPressのバージョン番号について一考しました。

テーブルブロックを投稿メタ(カスタムフィールド)に保存する(2022年1月5日 更新)

ふと「テーブルブロックの内容を投稿メタ(カスタムフィールド)として保存できたら便利なのでは」と思い、投稿メタの使い方を調べてみた。

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

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

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

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

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

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