• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/register post status

提供: WordPress Codex 日本語版
移動先: 案内検索

投稿ステータスを登録します。init アクションより前にこの関数を使用しないでください。

与えられたパラメータに基づいて、投稿ステータスを作成または変更するための簡単な関数です。この関数は 2 つのパラメータを取ります。最初が投稿ステータスを表す文字列、2 つめは引数の配列です。

注意:
この関数は、登録された投稿ステータスを管理画面に追加しません。その機能はまだ開発されていません。詳細は Trac チケット #12706 を参照してください。このパラメーターを追加するには、アクションフック post_submitbox_misc_actions の利用を検討してください。

使い方

<?php register_post_status( $post_status, $args ); ?>

パラメータ

$post_status
文字列) (必須) 投稿ステータスの名前。最大長は20文字。
初期値: なし
$args
配列|文字列) (オプション) この投稿ステータスの働き等を定義する引数。
初期値: なし

引数

label
文字列) (オプション) 投稿ステータスを翻訳するための名前。
初期値: $post_status
public
真偽値) (オプション) この投稿ステータスをサイトのフロントエンドに表示するかどうか。
初期値: false


exclude_from_search
真偽値) (オプション) この投稿ステータスを持つ投稿を検索結果から除外するかどうか。
初期値: false
show_in_admin_all_list
真偽値) (オプション) この投稿ステータスを持つ投稿を管理画面の「すべて」のリストに含めるかどうか。
初期値: true
show_in_admin_status_list
真偽値) (オプション) 管理画面の投稿リストの上にある、ステータスと投稿数のリストに含めるかどうか。例えば All (12) , Published (9) , My Custom Status (2) ...
初期値: true
label_count
配列) (オプション) 管理画面に表示するテキスト(省略するとステータスと投稿数が表示されない)。配列は _n_noop()/en の出力と同じ形式にする。
初期値: なし

用例

次は、投稿ステータス「未読(unread)」を追加する例です。

function my_custom_post_status(){
	register_post_status( 'unread', array(
		'label'                     => _x( 'Unread', 'post' ),
		'public'                    => true,
		'exclude_from_search'       => false,
		'show_in_admin_all_list'    => true,
		'show_in_admin_status_list' => true,
		'label_count'               => _n_noop( '未読 <span class="count">(%s)</span>', '未読 <span class="count">(%s)</span>' ),
	) );
}
add_action( 'init', 'my_custom_post_status' );

変更履歴

  • 3.0 : 新規導入。

ソースファイル

register_post_status()wp-includes/post.php にあります。

リソース

最新英語版: WordPress Codex » Function Reference/register_post_status最新版との差分