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



お勧め

Gutenberg、「新規追加」に難あり(2018年10月25日 更新)

昨日公開した「Gutenberg、初見です」で自作プラグインの「複製」機能が正しく動作していないことについて軽く触れた。該当するプラグインを修正するにしても原因がはっきりしないと手の打ちようがない。そんなわけで、不具合の原因を調べてみた。

「投稿に挿入」時のタグをちょっとカスタマイズ(2011年7月29日 更新)

投稿画面において、画像をアップロードし投稿に挿入するすると、imgタグをaタグで囲んだものが挿入される(キャプションを指定した場合はタグも)。それらの画像をLightBox(JavaScriptライブラリ)で表示する場合、aタグにrel属性を追加するのだが、その作業を毎回投稿に挿入した後で行うのがちょっと面倒。というわけで、自動的にrel属性を追加するようにしてみました。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

index.htmlでアーカイブページを表示させる(2011年10月14日 更新)

静的なサイトでは、各ディレクトリにindex.htmlファイルを置き、そのディレクトリの内容を紹介することが多い。WordPressで構築したサイトも同様にできないかと考え、試行錯誤してみた(こんなことを考えてるのは自分だけだろうか!?)。

タイトルが一致する投稿を検索する(2014年2月20日 更新)

WordPressが提供する投稿ページの文字列検索機能の実現には、 query_posts関数(WP_Queryクラス)が大きな役割を担っている。ここで紹介するのは、高機能ゆえに使いこなすのが難しいquery_posts関数(WP_Queryクラス)の使用法の一例である。