「関数リファレンス/add role」の版間の差分

2015年3月9日 (月) 17:05時点における版

WordPressに新しい権限グループを追加します。

注意: この設定はデータベース(wp_optionsテーブルのwp_user_rolesフィールド)に保存されるので、テーマやプラグインの有効化の時に実行するのが良いでしょう。

<?php add_role( $role, $display_name, $capabilities ); ?>

$role

（文字列） （必須） 権限グループ名

初期値： なし

$display_name

（文字列） （必須） 権限グループ表示名

初期値： なし

$capabilities

（配列） （必須） 権限の配列(使用可能な機能のリストはユーザーの種類と権限を参照

初期値： なし

(mixed) 

成功時はWP_Roleオブジェクトと返し、その権限グループがすでに存在する場合Nullを返します。

新しく"Basic Contributor"権限グループを作成します。

$result = add_role(
    'basic_contributor',
    __( 'Basic Contributor' ),
    array(
        'read'         => true,  // trueはこの機能を使用可にします。
        'edit_posts'   => true,
        'delete_posts' => false, // 明示的に使用しないとする場合はfalseを使用します。
    )
);
if ( null !== $result ) {
    echo '新しい権限グループを作成しました！';
}
else {
    echo 'すでに"basic_contributor"権限グループは存在します。';
}

プラグインを有効化した際に新しい権限グループを作成します。参照：register_activation_hook

   function add_roles_on_plugin_activation() {
       add_role( 'custom_role', 'Custom Subscriber', array( 'read' => true, 'level_0' => true ) );
   }
   register_activation_hook( __FILE__, 'add_roles_on_plugin_activation' );

When to cal

Make sure that the global $wp_roles is available before attempting to add or modify a role. The best practice of course is to use your plugin- or theme-activation hook to make changes to roles (since you only want to do it once!).

mu-plugins will load too early, so use an action hook (like 'init') to wrap your add_role() call if you're doing this in the context of an mu-plugin.

Delete existing role

If you are defining a custom role, and adding capabilities to the role using add_role(), be aware that modifying the capabilities array and re-executing add_role() will not necessarily update the role with the new capabilities list. The add_role() function short-circuits if the role already exists in the database.

The workaround in this case is to precede your add_role() call with a remove_role() call that targets the role you are adding.

This is for development only. Once you have nailed down your list of capabilities, there's no need to keep the remove_role() code, though there is, in fact, no harm in doing so.

バージョン 2.0.0 にて導入されました。

add_role() は wp-includes/capabilities.php にあります。

権限グループと権限:

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

最新英語版： WordPress Codex » Function_Reference/add_role （最新版との差分）