当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

「関数リファレンス/get post type capabilities」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(見出しのみ翻訳。原文リンク追加。)
(和訳しました。)
 
1行目: 1行目:
{{NeedTrans}}
+
{{CheckTrans}}
  
<div id="Description">
+
== 説明<span id="Description"></span> ==
== 説明 ==
+
</div>
+
  
Builds an object with all post type capabilities out of a post type object. Post type capabilities use the <tt>'capability_type'</tt> argument as a base, if the capability is not set in the <tt>'capabilities'</tt> argument array or if the <tt>'capabilities'</tt> argument is not supplied. The <tt>capability_type</tt> argument can optionally be registered as an array, with the first value being singular and the second plural, e.g. <tt>array('story, 'stories')</tt> Otherwise, an 's' will be added to the value for the plural form. After registration, <tt>capability_type</tt> will always be a string of the singular value.
+
ある投稿タイプのすべての投稿タイプ権限を持つオブジェクトを生成します。<!-- Builds an object with all post type capabilities out of a post type object. -->
  
<div id="Usage">
+
投稿タイプ権限は、権限が <tt>'capabilities'</tt> 引数(配列)にセットされていないか、または <tt>'capabilities'</tt> 引数が与えられない場合、<tt>'capability_type'</tt> 引数をベースにして作られます。
== 使い方 ==
+
 
</div>
+
<tt>'capability_type'</tt> 引数はオプションで配列にできます。配列は例えば <code>array('story, 'stories')</code> のように最初の値が単数形、2番目が複数形です。配列にしない場合(文字列を与えます)、それに 's' を付けた値が複数形として使われます。登録後、<tt>capability_type</tt> は常に単数形の文字列になります。<!-- After registration, <tt>capability_type</tt> will always be a string of the singular value. -->
 +
 
 +
== 使い方<span id="Usage"></span> ==
  
 
  <?php get_post_type_capabilities( $args ) ?>
 
  <?php get_post_type_capabilities( $args ) ?>
  
<div id="Parameters">
+
== パラメータ<span id="Parameters"></span> ==
== パラメータ ==
+
 
</div>
+
{{Parameter|$args|オブジェクト|引数を含むオブジェクト。}}
 +
 
 +
=== 引数 ===
 +
 
 +
<div class="information">'''参考''': 以下の引数は <tt>[[関数リファレンス/register_post_type|register_post_type()]]</tt> の同名の引数と同じ形式で指定します。</div>
 +
 
 +
{{Parameter|capability_type|文字列&#124;配列|閲覧/編集/削除の権限を構築する文字列。権限を構築するベースにこの引数を使う場合、配列を指定すると複数形の名前を変更できる。例えば <code>array('story', 'stories')</code> を指定すると、最初の要素が単数形の権限、2番目が複数形の権限として使われる。これは、配列を指定しない場合に自動生成される名前(<tt>'storys'</tt> になる筈)の代わりになる。<tt>'capabilities'</tt> 引数によって明示的にセットされなければ、この <tt>'capability_type'</tt> 引数が権限構築のベースとして使われる。|オプション}}
 +
 
 +
{{Parameter|capabilities|配列|権限の配列。|オプション|<tt>'capability_type'</tt> を使って構築される}}
 +
: デフォルトでは、権限の配列に7つのキーを入れることができる:
 +
:* '''<tt>edit_post</tt>''', '''<tt>read_post</tt>''', '''<tt>delete_post</tt>''' - これら3つは'''メタ権限'''であり、通常はコンテキストに応じて、対応する'''基本権限'''に変換される。コンテキストは、編集/閲覧/削除される投稿(投稿タイプ)と、チェックされるユーザーまたは権限グループ(role)で決まる。つまり、これらの権限は通常、ユーザーや権限グループに対して直接に許可されるものではない。
 +
:* '''<tt>edit_posts</tt>''' - この投稿タイプのオブジェクトの編集可否を制御する。
 +
:* '''<tt>edit_others_posts</tt>''' - この投稿タイプの、他のユーザーが所有するオブジェクトの編集可否を制御する。投稿タイプが作成者(author)をサポートしなければ、これは <tt>edit_posts</tt> と同様に振る舞う。
 +
:* '''<tt>publish_posts</tt>''' - この投稿タイプのオブジェクトの公開可否を制御する。
 +
:* '''<tt>read_private_posts</tt>''' - プライベートなオブジェクトの閲覧可否を制御する。
  
{{Parameter|$args|配列/文字列| The desired capability type (e.g. 'post').  Set ['capability_type'] to an array to allow for alternative plurals when using this argument as a base to construct the capabilities, e.g. array('story', 'stories').  Set ['map_meta_cap'] to <tt>true</tt> to obtain those capabilities as well.
+
: '''参考''': 後の4つは'''基本権限'''であり、WordPress コアのいろいろな箇所でチェックされる。
}}
+
  
By default, seven keys are accepted as part of the capabilities array:
+
{{Parameter|map_meta_cap|真偽値|WordPress が持つデフォルトのメタ権限処理を使用するかどうか。|オプション|false}}
* '''<tt>edit_post</tt>''', '''<tt>read_post</tt>''', and '''<tt>delete_post</tt>''' are meta capabilities, which are then generally mapped to corresponding primitive capabilities depending on the context, which would be the post being edited/read/deleted and the user or role being checked. Thus these capabilities would generally not be granted directly to users or roles.
+
* '''<tt>edit_posts</tt>''' - Controls whether objects of this post type can be edited.
+
* '''<tt>edit_others_posts</tt>''' - Controls whether objects of this type owned by other users can be edited. If the post type does not support an author, then this will behave like <tt>edit_posts</tt>.
+
* '''<tt>publish_posts</tt>''' - Controls publishing objects of this post type.
+
* '''<tt>read_private_posts</tt>''' - Controls whether private objects can be read.
+
  
These four primitive capabilities are checked in core in various locations.
+
: さらに7つの基本権限があるが、それらは <tt>[[関数リファレンス/map_meta_cap|map_meta_cap()]]</tt> /[[:en:Function Reference/map_meta_cap|en]] を除く WordPress コアでは直接参照されない。<tt>map_meta_cap()</tt> は、先に説明した3つの'''メタ権限'''を受け取り、コンテキストによってユーザーや権限グループに対してチェックされる一つ以上の'''基本権限'''へ変換する。
  
There are also seven other primitive capabilities which are not referenced directly in core, except in <tt>[[Function_Reference/map_meta_cap | map_meta_cap()]]</tt>, which takes the three aforementioned meta capabilities and translates them into one or more primitive capabilities that must then be checked against the user or role, depending on the context.
+
: この7つの権限は <tt>map_meta_cap()</tt> の中でのみ使われるので、これらは <tt>'map_meta_cap'</tt> を true にした場合のみ返される。
* '''<tt>read</tt>''' - Controls whether objects of this post type can be read.
+
:* '''<tt>read</tt>''' - この投稿タイプのオブジェクトの閲覧可否を制御する。
* '''<tt>delete_posts</tt>''' - Controls whether objects of this post type can be deleted.
+
:* '''<tt>delete_posts</tt>''' - この投稿タイプのオブジェクトの削除可否を制御する。
* '''<tt>delete_private_posts</tt>''' - Controls whether private objects can be deleted.
+
:* '''<tt>delete_private_posts</tt>''' - この投稿タイプのプライベートなオブジェクトの削除可否を制御する。
* '''<tt>delete_published_posts</tt>''' - Controls whether published objects can be deleted.
+
:* '''<tt>delete_published_posts</tt>''' - この投稿タイプの公開されているオブジェクトの削除可否を制御する。
* '''<tt>delete_others_posts</tt>''' - Controls whether objects owned by other users can be  can be deleted. If the post type does not support an author, then this will behave like delete_posts.
+
:* '''<tt>delete_others_posts</tt>''' - 他のユーザーが所有するこの投稿タイプのオブジェクトの削除可否を制御する。投稿タイプが作成者をサポートしなければ、これは delete_posts と同様に振る舞う。
* '''<tt>edit_private_posts</tt>''' - Controls whether private objects can be edited.
+
:* '''<tt>edit_private_posts</tt>''' - この投稿タイプのプライベートなオブジェクトの編集可否を制御する。
* '''<tt>edit_published_posts</tt>''' - Controls whether published objects can be edited.
+
:* '''<tt>edit_published_posts</tt>''' - この投稿タイプの公開されているオブジェクトの編集可否を制御する。
  
These additional capabilities are only used in <tt>map_meta_cap()</tt>. Thus, they are only assigned by default if the post type is registered with the <tt>'map_meta_cap'</tt> argument set to <tt>true</tt> (default is <tt>false</tt>).
+
== 戻り値<span id="Return"></span> ==
  
<div id="Return">
+
; <tt>(オブジェクト)</tt> : メンバー変数としてすべての権限を持つオブジェクト。
== 戻り値 ==
+
</div>
+
  
; <tt>(object)</tt> : Object with all capabilities as member variables
+
== 用例<span id="Examples"></span> ==
  
<div id="Examples">
+
== 参考<span id="Notes"></span> ==
== 用例 ==
+
</div>
+
  
<div id="Change_Log">
+
== 変更履歴<span id="Change_Log"></span> ==
== 変更履歴 ==
+
</div>
+
  
 
* 新規導入: [[Version 3.0|3.0]]
 
* 新規導入: [[Version 3.0|3.0]]
  
<div id="Source_File">
+
== ソースファイル<span id="Source_File"></span> ==
== ソースファイル ==
+
</div>
+
  
 
<tt>get_post_type_capabilities()</tt> は {{Trac|wp-includes/post.php}} にあります。
 
<tt>get_post_type_capabilities()</tt> は {{Trac|wp-includes/post.php}} にあります。
  
<div id="Related">
+
== 関連項目<span id="Related"></span> ==
== 関連項目 ==
+
</div>
+
  
 
{{Post Type Tags}}
 
{{Post Type Tags}}

2017年4月21日 (金) 00:40時点における最新版

この項目「関数リファレンス/get post type capabilities」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

説明

ある投稿タイプのすべての投稿タイプ権限を持つオブジェクトを生成します。

投稿タイプ権限は、権限が 'capabilities' 引数(配列)にセットされていないか、または 'capabilities' 引数が与えられない場合、'capability_type' 引数をベースにして作られます。

'capability_type' 引数はオプションで配列にできます。配列は例えば array('story, 'stories') のように最初の値が単数形、2番目が複数形です。配列にしない場合(文字列を与えます)、それに 's' を付けた値が複数形として使われます。登録後、capability_type は常に単数形の文字列になります。

使い方

<?php get_post_type_capabilities( $args ) ?>

パラメータ

$args
オブジェクト) (必須) 引数を含むオブジェクト。
初期値: なし

引数

参考: 以下の引数は register_post_type() の同名の引数と同じ形式で指定します。
capability_type
文字列|配列) (オプション) 閲覧/編集/削除の権限を構築する文字列。権限を構築するベースにこの引数を使う場合、配列を指定すると複数形の名前を変更できる。例えば array('story', 'stories') を指定すると、最初の要素が単数形の権限、2番目が複数形の権限として使われる。これは、配列を指定しない場合に自動生成される名前('storys' になる筈)の代わりになる。'capabilities' 引数によって明示的にセットされなければ、この 'capability_type' 引数が権限構築のベースとして使われる。
初期値: なし
capabilities
配列) (オプション) 権限の配列。
初期値: 'capability_type' を使って構築される
デフォルトでは、権限の配列に7つのキーを入れることができる:
  • edit_post, read_post, delete_post - これら3つはメタ権限であり、通常はコンテキストに応じて、対応する基本権限に変換される。コンテキストは、編集/閲覧/削除される投稿(投稿タイプ)と、チェックされるユーザーまたは権限グループ(role)で決まる。つまり、これらの権限は通常、ユーザーや権限グループに対して直接に許可されるものではない。
  • edit_posts - この投稿タイプのオブジェクトの編集可否を制御する。
  • edit_others_posts - この投稿タイプの、他のユーザーが所有するオブジェクトの編集可否を制御する。投稿タイプが作成者(author)をサポートしなければ、これは edit_posts と同様に振る舞う。
  • publish_posts - この投稿タイプのオブジェクトの公開可否を制御する。
  • read_private_posts - プライベートなオブジェクトの閲覧可否を制御する。
参考: 後の4つは基本権限であり、WordPress コアのいろいろな箇所でチェックされる。
map_meta_cap
真偽値) (オプション) WordPress が持つデフォルトのメタ権限処理を使用するかどうか。
初期値: false
さらに7つの基本権限があるが、それらは map_meta_cap() /en を除く WordPress コアでは直接参照されない。map_meta_cap() は、先に説明した3つのメタ権限を受け取り、コンテキストによってユーザーや権限グループに対してチェックされる一つ以上の基本権限へ変換する。
この7つの権限は map_meta_cap() の中でのみ使われるので、これらは 'map_meta_cap' を true にした場合のみ返される。
  • read - この投稿タイプのオブジェクトの閲覧可否を制御する。
  • delete_posts - この投稿タイプのオブジェクトの削除可否を制御する。
  • delete_private_posts - この投稿タイプのプライベートなオブジェクトの削除可否を制御する。
  • delete_published_posts - この投稿タイプの公開されているオブジェクトの削除可否を制御する。
  • delete_others_posts - 他のユーザーが所有するこの投稿タイプのオブジェクトの削除可否を制御する。投稿タイプが作成者をサポートしなければ、これは delete_posts と同様に振る舞う。
  • edit_private_posts - この投稿タイプのプライベートなオブジェクトの編集可否を制御する。
  • edit_published_posts - この投稿タイプの公開されているオブジェクトの編集可否を制御する。

戻り値

(オブジェクト) 
メンバー変数としてすべての権限を持つオブジェクト。

用例

参考

変更履歴

  • 新規導入: 3.0

ソースファイル

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

関連項目

投稿タイプ: register_post_type(), add_post_type_support(), remove_post_type_support(), post_type_supports(), post_type_exists(), set_post_type(), get_post_type(), get_post_types(), get_post_type_object(), get_post_type_capabilities(), get_post_type_labels(), is_post_type_hierarchical(), is_post_type_archive(), post_type_archive_title()


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function_Reference/get_post_type_capabilities最新版との差分