1. 8.5.x core/modules/views/src/Plugin/views/argument_validator/Entity.php Entity
  2. 8.5.x core/lib/Drupal/Core/Entity/Entity.php Entity
  3. 8.5.x core/modules/migrate/src/Plugin/migrate/destination/Entity.php Entity
  4. 8.5.x core/modules/views/src/Plugin/views/area/Entity.php Entity
  5. 8.0.x core/modules/views/src/Plugin/views/argument_validator/Entity.php Entity
  6. 8.0.x core/lib/Drupal/Core/Entity/Entity.php Entity
  7. 8.0.x core/modules/migrate/src/Plugin/migrate/destination/Entity.php Entity
  8. 8.0.x core/modules/views/src/Plugin/views/area/Entity.php Entity
  9. 8.1.x core/modules/views/src/Plugin/views/area/Entity.php Entity
  10. 8.1.x core/modules/views/src/Plugin/views/argument_validator/Entity.php Entity
  11. 8.1.x core/modules/migrate/src/Plugin/migrate/destination/Entity.php Entity
  12. 8.1.x core/lib/Drupal/Core/Entity/Entity.php Entity
  13. 8.2.x core/modules/views/src/Plugin/views/area/Entity.php Entity
  14. 8.2.x core/lib/Drupal/Core/Entity/Entity.php Entity
  15. 8.2.x core/modules/migrate/src/Plugin/migrate/destination/Entity.php Entity
  16. 8.2.x core/modules/views/src/Plugin/views/argument_validator/Entity.php Entity
  17. 8.3.x core/modules/migrate/src/Plugin/migrate/destination/Entity.php Entity
  18. 8.3.x core/lib/Drupal/Core/Entity/Entity.php Entity
  19. 8.3.x core/modules/views/src/Plugin/views/argument_validator/Entity.php Entity
  20. 8.3.x core/modules/views/src/Plugin/views/area/Entity.php Entity
  21. 8.4.x core/lib/Drupal/Core/Entity/Entity.php Entity
  22. 8.4.x core/modules/migrate/src/Plugin/migrate/destination/Entity.php Entity
  23. 8.4.x core/modules/views/src/Plugin/views/area/Entity.php Entity
  24. 8.4.x core/modules/views/src/Plugin/views/argument_validator/Entity.php Entity
  25. 8.6.x core/modules/views/src/Plugin/views/argument_validator/Entity.php Entity
  26. 8.6.x core/modules/views/src/Plugin/views/area/Entity.php Entity
  27. 8.6.x core/modules/migrate/src/Plugin/migrate/destination/Entity.php Entity
  28. 8.6.x core/lib/Drupal/Core/Entity/Entity.php Entity

Defines a argument validator plugin for each entity type.

Plugin annotation

  id = "entity",
  deriver = "Drupal\views\Plugin\Derivative\ViewsEntityArgumentValidator"


Expanded class hierarchy of Entity

See also


4 files declare their use of Entity
EntityTest.php in core/modules/views/tests/src/Unit/Plugin/argument_validator/EntityTest.php
Term.php in core/modules/taxonomy/src/Plugin/views/argument_validator/Term.php
TermName.php in core/modules/taxonomy/src/Plugin/views/argument_validator/TermName.php
User.php in core/modules/user/src/Plugin/views/argument_validator/User.php
4 string references to 'Entity'
comment_token_info in core/modules/comment/comment.tokens.inc
Implements hook_token_info().
EntityTypeManager::__construct in core/lib/Drupal/Core/Entity/EntityTypeManager.php
Constructs a new Entity plugin manager.
views.area.schema.yml in core/modules/views/config/schema/views.area.schema.yml
views.view.files.yml in core/modules/file/config/optional/views.view.files.yml


core/modules/views/src/Plugin/views/argument_validator/Entity.php, line 21


View source
class Entity extends ArgumentValidatorPluginBase {

   * The entity manager.
   * @var \Drupal\Core\Entity\EntityManagerInterface
  protected $entityManager;

   * If this validator can handle multiple arguments.
   * @var bool
  protected $multipleCapable = TRUE;

   * Constructs an \Drupal\views\Plugin\views\argument_validator\Entity 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\Core\Entity\EntityManagerInterface $entity_manager
   *   The entity manager.
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityManagerInterface $entity_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityManager = $entity_manager;

   * {@inheritdoc}
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container

   * {@inheritdoc}
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['bundles'] = array(
      'default' => array(),
    $options['access'] = array(
      'default' => FALSE,
    $options['operation'] = array(
      'default' => 'view',
    $options['multiple'] = array(
      'default' => FALSE,
    return $options;

   * {@inheritdoc}
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $entity_type_id = $this->definition['entity_type'];

    // Derivative IDs are all entity:entity_type. Sanitized for js.
    // The ID is converted back on submission.
    $sanitized_id = ArgumentPluginBase::encodeValidatorId($this->definition['id']);
    $entity_type = $this->entityManager

    // If the entity has bundles, allow option to restrict to bundle(s).
    if ($entity_type
      ->hasKey('bundle')) {
      $bundle_options = array();
      foreach ($this->entityManager
        ->getBundleInfo($entity_type_id) as $bundle_id => $bundle_info) {
        $bundle_options[$bundle_id] = $bundle_info['label'];
      $form['bundles'] = array(
        '#title' => $entity_type
          ->getBundleLabel() ?: $this
        '#default_value' => $this->options['bundles'],
        '#type' => 'checkboxes',
        '#options' => $bundle_options,
        '#description' => $this
          ->t('If none are selected, all are allowed.'),

    // Offer the option to filter by access to the entity in the argument.
    $form['access'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Validate user has access to the %name', array(
        '%name' => $entity_type
      '#default_value' => $this->options['access'],
    $form['operation'] = array(
      '#type' => 'radios',
      '#title' => $this
        ->t('Access operation to check'),
      '#options' => array(
        'view' => $this
        'update' => $this
        'delete' => $this
      '#default_value' => $this->options['operation'],
      '#states' => array(
        'visible' => array(
          ':input[name="options[validate][options][' . $sanitized_id . '][access]"]' => array(
            'checked' => TRUE,

    // If class is multiple capable give the option to validate single/multiple.
    if ($this->multipleCapable) {
      $form['multiple'] = array(
        '#type' => 'radios',
        '#title' => $this
          ->t('Multiple arguments'),
        '#options' => array(
          0 => $this
            ->t('Single ID', array(
            '%type' => $entity_type
          1 => $this
            ->t('One or more IDs separated by , or +', array(
            '%type' => $entity_type
        '#default_value' => (string) $this->options['multiple'],

   * {@inheritdoc}
  public function submitOptionsForm(&$form, FormStateInterface $form_state, &$options = array()) {

    // Filter out unused options so we don't store giant unnecessary arrays.
    $options['bundles'] = array_filter($options['bundles']);

   * {@inheritdoc}
  public function validateArgument($argument) {
    $entity_type = $this->definition['entity_type'];
    if ($this->multipleCapable && $this->options['multiple']) {

      // At this point only interested in individual IDs no matter what type,
      // just splitting by the allowed delimiters.
      $ids = array_filter(preg_split('/[,+ ]/', $argument));
    elseif ($argument) {
      $ids = array(
    else {
      return FALSE;
    $entities = $this->entityManager

    // Validate each id => entity. If any fails break out and return false.
    foreach ($ids as $id) {

      // There is no entity for this ID.
      if (!isset($entities[$id])) {
        return FALSE;
      if (!$this
        ->validateEntity($entities[$id])) {
        return FALSE;
    return TRUE;

   * Validates an individual entity against class access settings.
   * @param \Drupal\Core\Entity\EntityInterface $entity
   * @return bool
   *   True if validated.
  protected function validateEntity(EntityInterface $entity) {

    // If access restricted by entity operation.
    if ($this->options['access'] && !$entity
      ->access($this->options['operation'])) {
      return FALSE;

    // If restricted by bundle.
    $bundles = $this->options['bundles'];
    if (count($bundles) && empty($bundles[$entity
      ->bundle()])) {
      return FALSE;
    return TRUE;

   * {@inheritdoc}
  public function calculateDependencies() {
    $dependencies = parent::calculateDependencies();
    $entity_type_id = $this->definition['entity_type'];
    $bundle_entity_type = $this->entityManager

    // The bundle entity type might not exist. For example, users do not have
    // bundles.
    if ($this->entityManager
      ->hasHandler($bundle_entity_type, 'storage')) {
      $bundle_entity_storage = $this->entityManager
      foreach ($bundle_entity_storage
        ->loadMultiple(array_keys($this->options['bundles'])) as $bundle_entity) {
          ->getConfigDependencyKey()][] = $bundle_entity
    return $dependencies;



Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
ArgumentValidatorPluginBase::$argument protected property The argument handler instance associated with this plugin.
ArgumentValidatorPluginBase::access public function Determines if the administrator has the privileges to use this plugin.
ArgumentValidatorPluginBase::checkAccess protected function Blocks user input when the form is shown but we don´t have access.
ArgumentValidatorPluginBase::processSummaryArguments public function Processes the summary arguments for displaying.
ArgumentValidatorPluginBase::setArgument public function Sets the parent argument this plugin is associated with.
ArgumentValidatorPluginBase::validateOptionsForm public function Provides the default form for validating options. Overrides PluginBase::validateOptionsForm
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Prevents serializing any properties.
DependencySerializationTrait::__wakeup public function
Entity::$entityManager protected property The entity manager.
Entity::$multipleCapable protected property If this validator can handle multiple arguments.
Entity::buildOptionsForm public function Provides the default form for setting options. Overrides ArgumentValidatorPluginBase::buildOptionsForm
Entity::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies
Entity::create public static function Creates an instance of the plugin. Overrides PluginBase::create
Entity::defineOptions protected function Retrieves the options when this is a new access control plugin. Overrides ArgumentValidatorPluginBase::defineOptions
Entity::submitOptionsForm public function Provides the default form for submitting options. Overrides ArgumentValidatorPluginBase::submitOptionsForm
Entity::validateArgument public function Performs validation for a given argument. Overrides ArgumentValidatorPluginBase::validateArgument
Entity::validateEntity protected function Validates an individual entity against class access settings.
Entity::__construct public function Constructs an \Drupal\views\Plugin\views\argument_validator\Entity object. Overrides PluginBase::__construct
PluginBase::$configuration protected property Configuration information passed into the plugin.
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::$usesOptions protected property Denotes whether the plugin has an additional options form.
PluginBase::$view public property The top object of a view.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. Overrides ViewsPluginInterface::destroy
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer.
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
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 Initialize the plugin. Overrides ViewsPluginInterface::init
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::query public function Add anything to the query that we might need to. Overrides ViewsPluginInterface::query
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::summaryTitle public function Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions
PluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface::validate
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.
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.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.