wp_count_posts

説明

object wp_count_posts( [ string $type = '' [ , string $perm = '' ] ] )
投稿数を取得する。

パラメータ

  • $type
    投稿タイプを指定(省略時は'post')
  • $perm
    'readable'または''を指定(省略時は'')

返り値

投稿ステータス別の投稿数を格納したオブジェクトを返す。オブジェクトのプロパティは次に示す通り投稿ステータス名であり、それぞれに投稿数が格納されている。
プロパティ内容
publish公開
future予約投稿
draft下書き
pendingレビュー待ち
private非公開
trashごみ箱
auto-draft自動下書き
inherit継承記事(リビジョンなど)

注意

パラメータ$permで'readable'を指定し、ユーザがログイン中( is_user_logged_in関数で調べる)でかつ他人のステータスが'private'な記事を閲覧できない( current_user_can関数で調べる)場合、検索対象はステータスが'private'以外か、そのユーザが投稿したステータスが'private'の投稿になる。

使用例

  • 投稿記事の投稿数を取得する。
    <?php $counts = wp_count_posts(); ?>
  • カスタム投稿タイプ'news'で'readable'して投稿数を取得する。
    <?php $counts = wp_count_posts( 'news', 'readable' ); ?>

フィルター

投稿数を返す直前に'wp_count_posts'フィルターを呼び出す(3.7.0以降)。$countsには投稿数の連想配列が、$type$permのそれぞれにはパラメータで受け取った値が格納される。
return apply_filters( 'wp_count_posts', $counts, $type, $perm );

アクション

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

ソースファイル

/wp-includes/post.php

最終更新 : 2013年10月31日 13:55



お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。