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



お勧め

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

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

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

ログインページを変える(2014年9月12日 更新)

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。