class User in Drupal 10

Default argument plugin to extract a user from request.

Plugin annotation

@ViewsArgumentDefault(
  id = "user",
  title = @Translation("User ID from route context")
)

Hierarchy

• class \Drupal\user\Plugin\views\argument_default\User extends \Drupal\views\Plugin\views\argument_default\ArgumentDefaultPluginBase implements CacheableDependencyInterface

31 string references to 'User'

CategoryAutocompleteTest::providerTestAutocompleteSuggestions in core/modules/block/tests/src/Unit/CategoryAutocompleteTest.php

Data provider for testAutocompleteSuggestions().

CategoryAutocompleteTest::setUp in core/modules/block/tests/src/Unit/CategoryAutocompleteTest.php

contact_entity_extra_field_info in core/modules/contact/contact.module

Implements hook_entity_extra_field_info().

ContentModerationState::baseFieldDefinitions in core/modules/content_moderation/src/Entity/ContentModerationState.php

ContextPluginTest::testContext in core/tests/Drupal/KernelTests/Core/Plugin/ContextPluginTest.php

Tests basic context definition and value getters and setters.

... See full list

File

core/modules/user/src/Plugin/views/argument_default/User.php, line 22

Namespace

Drupal\user\Plugin\views\argument_default

class User extends ArgumentDefaultPluginBase implements CacheableDependencyInterface {

  /**
   * The route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * Constructs a new User instance.
   *
   * @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\Routing\RouteMatchInterface $route_match
   *   The route match.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteMatchInterface $route_match) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->routeMatch = $route_match;
  }

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

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['user'] = [
      'default' => '',
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    $form['user'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Also look for a node and use the node author'),
      '#default_value' => $this->options['user'],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getArgument() {

    // If there is a user object in the current route.
    if ($user = $this->routeMatch
      ->getParameter('user')) {
      if ($user instanceof UserInterface) {
        return $user
          ->id();
      }
    }

    // If option to use node author; and node in current route.
    if (!empty($this->options['user']) && ($node = $this->routeMatch
      ->getParameter('node'))) {
      if ($node instanceof NodeInterface) {
        return $node
          ->getOwnerId();
      }
    }
  }

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

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    return [
      'url',
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	14
User::$routeMatch	protected	property	The route match.
User::buildOptionsForm	public	function
User::create	public static	function
User::defineOptions	protected	function
User::getArgument	public	function
User::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
User::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
User::__construct	public	function	Constructs a new User instance.