関数リファレンス/add cap

このページ「関数リファレンス/add cap」は参考節以降が未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています。

説明

権限グループまたは特定のユーザーに権限を追加します。 権限グループまたはユーザーの権限変更は永続的なものです。追加された権限は、明示的に取り消されるまで有効です。

注意: この設定はデータベース(テーブル wp_options のフィールド wp_user_roles)へ保存されます。そのため、テーマやプラグインを有効化した時に実行したほうがいいかもしれません。

使い方

<?php 
  global $wp_roles; // global class wp-includes/capabilities.php
  $wp_roles->add_cap( $role, $cap ); 
 ?> 

または

<?php
  $role = get_role( 'author' );
  $role->add_cap( $cap );
?>

パラメータ

role

（文字列） （必須） 権限グループ名(クラス WP_Roles に保持されている)

初期値： なし

cap

（文字列） （必須） 権限名

初期値： なし

grant

（真偽値） （オプション） 権限グループにこの権限を付与するかどうか

初期値： true

戻り値

void 

この関数は値を返しません。

用例

function add_theme_caps() {
    // 投稿者の権限グループを取得
    $role = get_role( 'author' );

    // これは、クラスインスタンスにアクセスする場合のみ機能します。
    // 現在のテーマにおいてのみ、投稿者は他の人の投稿を編集することができます。
    $role->add_cap( 'edit_others_posts' ); 
}
add_action( 'admin_init', 'add_theme_caps');

注意: この設定はデータベース(テーブル wp_options のフィールド wp_user_roles)へ保存されます。そのため、テーマやプラグインを有効化した時に実行したほうがいいかもしれません。

function add_theme_caps(){
  global $pagenow;

  // 投稿者の権限グループを取得
  $role = get_role( 'author' );

  if ( 'themes.php' == $pagenow && isset( $_GET['activated'] ) ){ // テーマが有効化されたか調べる
    // テーマが有効化された

    // これは、クラスインスタンスにアクセスする場合のみ機能します。
    // 現在のテーマにおいてのみ、投稿者は他の人の投稿を編集することができます。
    $role->add_cap( 'edit_others_posts' ); 
  }
  else {
    // テーマが無効化された
    // テーマが無効化された時、権限を削除する
    $role->remove_cap( 'edit_others_posts' ); 
  }
}
add_action( 'load-themes.php', 'add_theme_caps' );

特定のユーザーに権限を追加する :

$user = new WP_User( $user_id );
$user->add_cap( 'can_edit_posts' );

参考

There is no public function called add_cap() - just the class methods inside WP_Roles, WP_Role, WP_User that can add capabilities.

If you want to add a new role with capabilities, just add them when you add the role using add_role();.

変更履歴

• Since 2.0.0

ソースファイル

add_cap は wp-includes/class-wp-role.php, wp-includes/class-wp-roles.php, wp-includes/class-wp-user.php にあります。

関連項目

権限グループと権限:

• add_role()
• remove_role()
• get_role()
• add_cap() /en
• remove_cap() /en

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

最新英語版： WordPress Codex » Function Reference/add cap （最新版との差分）