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

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

関数リファレンス/get post type capabilities

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

この項目「関数リファレンス/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最新版との差分