class AccessPluginBase

The base plugin to handle access control.

Access plugins are responsible for controlling a user's access to the view. Views includes plugins for checking user roles and individual permissions.

To define an access control plugin, extend this base class. Your access plugin should have an annotation that includes the plugin's metadata, for example:

#[ViewsAccess(
  id: "deny_all",
  title: new TranslatableMarkup("No Access"),
  help: new TranslatableMarkup("Will not be accessible.")
)]

The definition should include the following keys:

• id: The unique identifier of your access plugin.
• title: The human-readable name for your access plugin.
• help: A short help message for your plugin.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
    • class \Drupal\views\Plugin\views\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface extends \Drupal\Core\Plugin\PluginBase
      • class \Drupal\views\Plugin\views\access\AccessPluginBase extends \Drupal\views\Plugin\views\PluginBase

Expanded class hierarchy of AccessPluginBase

See also

\Drupal\views\Plugin\ViewsPluginManager

Related topics

File

core/modules/views/src/Plugin/views/access/AccessPluginBase.php, line 49

Namespace

abstract class AccessPluginBase extends PluginBase {
  
  /**
   * {@inheritdoc}
   */
  public function summaryTitle() {
    return $this->t('Unknown');
  }
  
  /**
   * Determine if the current user has access or not.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The user who wants to access this view.
   *
   * @return bool
   *   Returns whether the user has access to the view.
   */
  abstract public function access(AccountInterface $account);
  
  /**
   * Allows access plugins to alter the route definition of a view.
   *
   * Likely the access plugin will add new requirements, so its custom access
   * checker can be applied.
   *
   * @param \Symfony\Component\Routing\Route $route
   *   The route to change.
   */
  abstract public function alterRouteDefinition(Route $route);

}

Members