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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

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

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

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。