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

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

「関数リファレンス/register post status」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function Reference/register_post_status 14:37, 14 June 2014 Uicestone 版を反映。)
1行目: 1行目:
 
{{テンプレートタグガイド|PHP}}
 
{{テンプレートタグガイド|PHP}}
  
 +
<div id="Description">
 
== 説明 ==
 
== 説明 ==
[[用語集#投稿ステータス|投稿ステータス]]を作成または変更します。init の前にこの関数を使用しないでください。
+
</div>
 +
[[投稿ステータス]]を登録します。init アクションより前にこの関数を使用しないでください。
  
与えられたパラメータに基づいて、投稿ステータスを作成または変更するための簡単な関数です。
+
与えられたパラメータに基づいて、投稿ステータスを作成または変更するための簡単な関数です。この関数は 2 つのパラメータを取ります。最初が投稿ステータスを表す文字列、2 つめは引数の配列です。
この関数は1つ目の引数に投稿ステータスのスラッグ、2つの引数にパラメータを取ります。
+
  
 +
<div style="margin:10px; border:1px solid blue; padding:5px">
 +
'''注意:'''<br />
 +
この関数は、登録された投稿ステータスを管理画面に追加''しません''。その機能はまだ開発されていません。詳細は [https://core.trac.wordpress.org/ticket/12706 Trac チケット #12706] を参照してください。このパラメーターを追加するには、アクションフック [http://core.trac.wordpress.org/browser/tags/3.5.1/wp-admin/includes/meta-boxes.php#L183 post_submitbox_misc_actions] の利用を検討してください。
 +
</div>
 +
 +
<div id="Usage">
 
== 使い方 ==
 
== 使い方 ==
 +
</div>
 
  <?php register_post_status( $post_status, $args ); ?>
 
  <?php register_post_status( $post_status, $args ); ?>
  
 +
<div id="Parameters">
 
== パラメータ ==
 
== パラメータ ==
{{Parameter|$post_status|文字列|投稿ステータスのスラッグ}}
+
</div>
{{Parameter|$args|配列|文字列または配列|引数の文字列または配列|オプション}}
+
{{Parameter|$post_status|文字列|投稿ステータスの名前}}
 +
{{Parameter|$args|配列&#124;文字列|この投稿ステータスの働き等を定義する引数|オプション}}
  
 +
<div id="Arguments">
 
=== 引数 ===
 
=== 引数 ===
{{Parameter|label|文字列|投稿ステータスの翻訳のための名前。|オプション|$post_type}}
+
</div>
{{Parameter|public|真偽値|この投稿ステータスをサイトのフロントページに表示するかどうか。|オプション|false}}
+
{{Parameter|label|文字列|投稿ステータスを翻訳するための名前。|オプション|$post_status}}
{{Parameter|protected|真偽値|この投稿ステータスのプレビューを許可するかどうか。''(英語版コーデックスに無い情報です。どなたか精査お願いします)''|オプション|false}}
+
{{Parameter|exclude_from_search|真偽値|この投稿ステータスを検索結果に''含めない''かどうか。|オプション|false}}
+
{{Parameter|show_in_admin_all_list|真偽値|この投稿ステータスを管理画面の ALL のリストに含めるかどうか。|オプション|false}}
+
{{Parameter|show_in_admin_status_list|真偽値|Show in the list of statuses with post counts at the top of the edit listings, e.g. All (12)|オプション|My Custom Status (2) ...}}
+
{{Parameter|label_count|文字列|管理画面に表示する文字列 (or you won't see your status count).|オプション|None}}
+
  
 +
{{Parameter|public|真偽値|この投稿ステータスをサイトのフロントエンドに表示するかどうか。|オプション|false}}
 +
 +
<!-- {{Parameter|protected|真偽値|この投稿ステータスのプレビューを許可するかどうか。''(英語版コーデックスに無い情報です。どなたか精査お願いします)''|オプション|false}} -->
 +
 +
{{Parameter|exclude_from_search|真偽値|この投稿ステータスを持つ投稿を検索結果から''除外する''かどうか。|オプション|false}}
 +
 +
{{Parameter|show_in_admin_all_list|真偽値|この投稿ステータスを持つ投稿を管理画面の「すべて」のリストに含めるかどうか。|オプション|true}}
 +
 +
{{Parameter|show_in_admin_status_list|真偽値|管理画面の投稿リストの上にある、ステータスと投稿数のリストに含めるかどうか。例えば All (12) , Published (9) , My Custom Status (2) ...|オプション|true}}
 +
 +
{{Parameter|label_count|配列|管理画面に表示するテキスト(省略するとステータスと投稿数が表示されない)。配列は <tt>[[関数リファレンス/_n_noop |_n_noop()]]/[[:en:Function_Reference/_n_noop |en]]</tt> の出力と同じ形式にする。|オプション}}
 +
 +
<div id="Example">
 
== 用例 ==
 
== 用例 ==
 +
</div>
 
次は、投稿ステータス「未読(unread)」を追加する例です。
 
次は、投稿ステータス「未読(unread)」を追加する例です。
  
40行目: 60行目:
 
</pre>
 
</pre>
  
 
+
<div id="Change_Log">
 
== 変更履歴 ==
 
== 変更履歴 ==
 +
</div>
 +
* [[Version 3.0|3.0]] : 新規導入。
  
* Since [[Version 3.0|3.0]]
+
<div id="Source_File">
 
+
 
== ソースファイル ==
 
== ソースファイル ==
 +
</div>
 
<tt>register_post_status()</tt> は {{Trac|wp-includes/post.php}} にあります。
 
<tt>register_post_status()</tt> は {{Trac|wp-includes/post.php}} にあります。
  
 +
<div id="Resources">
 
== リソース ==
 
== リソース ==
 +
</div>
 
* [http://generatewp.com/post-status/ WordPress Post Status Generator]
 
* [http://generatewp.com/post-status/ WordPress Post Status Generator]
  
{{原文|Function Reference/register_post_status|91386}}
+
<div id="Related">
 +
== 関連資料 ==
 +
</div>
 +
* [[投稿ステータス]]
 +
 
 +
{{原文|Function Reference/register_post_status|144234}} <!-- 14:37, 14 June 2014 Uicestone 版 -->
  
== 関連 ==
+
{{DEFAULTSORT:Register_post_status}}
 
[[Category:関数]]
 
[[Category:関数]]
 
[[Category:wp3.0]]
 
[[Category:wp3.0]]
  
 
[[en:Function Reference/register_post_status]]
 
[[en:Function Reference/register_post_status]]

2015年4月9日 (木) 02:52時点における版

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

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

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

使い方

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

パラメータ

$post_status
文字列) (必須) 投稿ステータスの名前
初期値: なし
$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最新版との差分