ユーザー権限

• On this Page

  • 権限の要求
  • 権限の確認

モジュールとプラグインは、EVENT_REGISTER_PERMISSIONS (opens new window) イベントを使用して新しいユーザー権限をシステムに登録できます。

use craft\events\RegisterUserPermissionsEvent;
use craft\services\UserPermissions;
use yii\base\Event;

public function init()
{
    parent::init();

    Event::on(
        UserPermissions::class,
        UserPermissions::EVENT_REGISTER_PERMISSIONS,
        function(RegisterUserPermissionsEvent $event) {
            $event->permissions['Permission Group Name'] = [
                'permissionName' => [
                    'label' => 'Permission Label',
                ],
            ];
        }
    );
}

権限は nested キーをパーミッションの配列に追加することで、ネストされた権限を持つこともできます。

'permissionName' => [
    'label' => 'Permission Label',
    'nested' => [
        'nestedPermissionName' => [
            'label' => 'Nested Permission Label',
        ],
    ],
];

権限の要求

コントローラーは、requirePermission() (opens new window) を呼び出すことで、ログインしているユーザー権限を持っていることを要求できます。

public function actionStayUpLate()
{
    // Require the `stayUpLate` permission
    $this->requirePermission('stayUpLate');
}

ユーザーがその権限を持たない場合、403 エラーが返されます。

テンプレートでは、requirePermission タグでユーザー権限を持っていることを保証することもできます。

{% requirePermission 'stayUpLate' %}

権限の確認

を呼び出すことで、ログインしているユーザーが権限を持っているかを確認できます。

// See if they have the `stayUpLate` permission
if (Craft::$app->user->checkPermission('stayUpLate')) {
    // ...
}

を呼び出すことで、指定されたユーザーが権限を持っているかを確認することもできます。

/** @var \craft\elements\User $user */
if ($user->can('stayUpLate')) {
    // ...
}