You are here

class Permission in Drupal 10

Same name and namespace in other branches
  1. 8 core/modules/user/src/Plugin/views/access/Permission.php \Drupal\user\Plugin\views\access\Permission
  2. 9 core/modules/user/src/Plugin/views/access/Permission.php \Drupal\user\Plugin\views\access\Permission

Access plugin that provides permission-based access control.

Plugin annotation

  id = "perm",
  title = @Translation("Permission"),
  help = @Translation("Access will be granted to users with the specified permission string.")


Expanded class hierarchy of Permission

Related topics

1 file declares its use of Permission
AccessPermissionTest.php in core/modules/user/tests/src/Kernel/Views/AccessPermissionTest.php
9 string references to 'Permission'
AccessPermissionTest::testAccessPerm in core/modules/user/tests/src/Kernel/Views/AccessPermissionTest.php
Tests perm access plugin.
drupal6.php in core/modules/migrate_drupal/tests/fixtures/drupal6.php
A database agnostic dump for testing purposes.
Permission::buildOptionsForm in core/modules/user/src/Plugin/views/access/Permission.php
Provide a form to edit options for this plugin.
user.schema.yml in core/modules/user/config/schema/user.schema.yml
user.views.schema.yml in core/modules/user/config/schema/user.views.schema.yml

... See full list


core/modules/user/src/Plugin/views/access/Permission.php, line 26


View source
class Permission extends AccessPluginBase implements CacheableDependencyInterface {

   * {@inheritdoc}
  protected $usesOptions = TRUE;

   * The permission handler.
   * @var \Drupal\user\PermissionHandlerInterface
  protected $permissionHandler;

   * The module handler.
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
  protected $moduleHandler;

   * Constructs a Permission object.
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\user\PermissionHandlerInterface $permission_handler
   *   The permission handler.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
  public function __construct(array $configuration, $plugin_id, $plugin_definition, PermissionHandlerInterface $permission_handler, ModuleHandlerInterface $module_handler) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->permissionHandler = $permission_handler;
    $this->moduleHandler = $module_handler;

   * {@inheritdoc}
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('user.permissions'), $container

   * {@inheritdoc}
  public function access(AccountInterface $account) {
    return $account

   * {@inheritdoc}
  public function alterRouteDefinition(Route $route) {
      ->setRequirement('_permission', $this->options['perm']);
  public function summaryTitle() {
    $permissions = $this->permissionHandler
    if (isset($permissions[$this->options['perm']])) {
      return $permissions[$this->options['perm']]['title'];
    return $this
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['perm'] = [
      'default' => 'access content',
    return $options;
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);

    // Get list of permissions
    $perms = [];
    $permissions = $this->permissionHandler
    foreach ($permissions as $perm => $perm_item) {
      $provider = $perm_item['provider'];
      $display_name = $this->moduleHandler
      $perms[$display_name][$perm] = strip_tags($perm_item['title']);
    $form['perm'] = [
      '#type' => 'select',
      '#options' => $perms,
      '#title' => $this
      '#default_value' => $this->options['perm'],
      '#description' => $this
        ->t('Only users with the selected permission flag will be able to access this display.'),

   * {@inheritdoc}
  public function getCacheMaxAge() {
    return Cache::PERMANENT;

   * {@inheritdoc}
  public function getCacheContexts() {
    return [

   * {@inheritdoc}
  public function getCacheTags() {
    return [];



Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 18
MessengerTrait::messenger public function Gets the messenger. 18
MessengerTrait::setMessenger public function Sets the messenger.
Permission::$moduleHandler protected property The module handler.
Permission::$permissionHandler protected property The permission handler.
Permission::$usesOptions protected property Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions
Permission::access public function Determine if the current user has access or not. Overrides AccessPluginBase::access
Permission::alterRouteDefinition public function Allows access plugins to alter the route definition of a view. Overrides AccessPluginBase::alterRouteDefinition
Permission::buildOptionsForm public function Provide a form to edit options for this plugin. Overrides PluginBase::buildOptionsForm
Permission::create public static function Creates an instance of the plugin. Overrides PluginBase::create
Permission::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides PluginBase::defineOptions
Permission::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
Permission::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
Permission::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
Permission::summaryTitle public function Returns the summary of the settings in the display. Overrides AccessPluginBase::summaryTitle
Permission::__construct public function Constructs a Permission object. Overrides PluginBase::__construct
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$renderer protected property Stores the render API renderer.
PluginBase::$view public property The top object of a view.
PluginBase::calculateDependencies public function 4
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function 1
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function
PluginBase::getAvailableGlobalTokens public function
PluginBase::getBaseId public function
PluginBase::getDerivativeId public function
PluginBase::getPluginDefinition public function 2
PluginBase::getPluginId public function
PluginBase::getProvider public function
PluginBase::getRenderer protected function Returns the render API renderer.
PluginBase::globalTokenForm public function
PluginBase::globalTokenReplace public function
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::init public function 2
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function
PluginBase::preRenderAddFieldsetMarkup public static function
PluginBase::preRenderFlattenData public static function
PluginBase::query public function 4
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::submitOptionsForm public function 4
PluginBase::themeFunctions public function
PluginBase::trustedCallbacks public static function 1
PluginBase::unpackOptions public function
PluginBase::usesOptions public function 6
PluginBase::validate public function 2
PluginBase::validateOptionsForm public function 5
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 1
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.