概要
current_user_can_for_site 関数は、現在のユーザーに指定されたサイトの権限があるか調べるための便利な関数です。この関数は、主にマルチサイト環境での権限のチェックに使用されます。具体的には次のような機能を実装する際によく使われます：
- ユーザーが特定のサイトに対して管理者権限を持つか確認する。
- 投稿やページの編集権限を確認する。
- プラグインの設定ページへのアクセスを制御する。
- 特定のカスタムポストタイプの作成権限をチェックする。
- サイトのテーマを変更する権限を確認する。
- ウィジェットエリアの設定や追加権限を確認する。
- APIリクエストに対するユーザーの適切な権限を調べる。
- フロントエンドで特定のコンテンツを表示するか条件を判断する。
構文
current_user_can_for_site( int|object $site_id, string $capability )
パラメータ
$site_id: 権限を確認する対象のサイトIDまたはサイトオブジェクト。$capability: チェックする権限のスラッグ（例: ‘edit_posts’）。
戻り値
trueまたはfalse: 指定された権限が現在のユーザーにある場合はtrue、ない場合はfalseを返します。
関連する関数
使用可能なバージョン
- WordPress 4.0以降で使用可能
コアファイルのパス
wp-includes/capabilities.php
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | 〇 |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | 〇 |
| template_redirect | |
| get_header | |
| wp_head |
非推奨または削除されたバージョン
- 非推奨や削除されたバージョンは現在ありません。