get_post_stati

説明

string[] | stdClass[] get_post_stati( [ array | string $args [ , string $output [ , string $operator ] ] ] )
投稿ステータスを取得する。

パラメータ

  • $args
    検索条件を指定(省略時はarray())
  • $output
    取得内容として'names'または'objects'を指定(省略時は'names')
  • $operator
    オペレーターとして'or'または'and'を指定(省略時は'and')

返り値

パラメータ$outputに応じて投稿ステータス名または投稿ステータスデータの配列を返す。

注意

wp_filter_object_list関数を使って、グローバル変数$wp_post_statusesの検索(絞り込み)を行っている。

パラメータ$outputが'objects'の場合、配列のキーが投稿ステータスのスラッグとなり、その値の投稿ステータスデータは以下の内容になる。

プロパティデータ型
label文字列"公開済み"
label_count配列
array(
	0 => "Published <span class="count">(%s)</span>",
	1 => "Published <span class="count">(%s)</span>",
	"singular" => "Published <span class="count">(%s)</span>",
	"plural" => "Published <span class="count">(%s)</span>",
	"context" => NULL,
	"domain" => NULL
)
exclude_from_searchブールfalse
_builtinブールtrue
publicブールtrue
internalブールfalse
protectedブールfalse
privateブールfalse
publicly_queryableブールtrue
show_in_admin_status_listブールtrue
show_in_admin_all_listブールtrue
date_floatingブールfalse
name文字列"publish"

パラメータ$argsに上記のプロパティと値の組み合わせを指定することで、取得する投稿ステータスを絞り込める。


使用例

  • 投稿ステータス名を取得する。
    $statuses = get_post_stati();
  • 公開されている投稿ステータスデータを取得する。
    $statuses = get_post_stati( array( 'public' => true ), 'objects' );

フィルター

実行するフィルターはありません。

アクション

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

ソースファイル

/wp-includes/post.php

最終更新 : 2026年01月28日 17:33



お勧め

個人データのエクスポートメール向けに追加された新フィルター(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つ前の「ニュース」で紹介されていた変更点から確認してみた。