Users.php

Same filename in other branches
  1. 9 core/modules/user/src/Plugin/views/wizard/Users.php
  2. 10 core/modules/user/src/Plugin/views/wizard/Users.php
  3. 11.x core/modules/user/src/Plugin/views/wizard/Users.php

Namespace

Drupal\user\Plugin\views\wizard

File

core/modules/user/src/Plugin/views/wizard/Users.php

View source
<?php

namespace Drupal\user\Plugin\views\wizard;

use Drupal\views\Plugin\views\wizard\WizardPluginBase;

/**
 * @todo: replace numbers with constants.
 */

/**
 * Tests creating user views with the wizard.
 *
 * @ViewsWizard(
 *   id = "users",
 *   base_table = "users_field_data",
 *   title = @Translation("Users")
 * )
 */
class Users extends WizardPluginBase {
    
    /**
     * Set the created column.
     *
     * @var string
     */
    protected $createdColumn = 'created';
    
    /**
     * Set default values for the filters.
     */
    protected $filters = [
        'status' => [
            'value' => TRUE,
            'table' => 'users_field_data',
            'field' => 'status',
            'plugin_id' => 'boolean',
            'entity_type' => 'user',
            'entity_field' => 'status',
        ],
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function defaultDisplayOptions() {
        $display_options = parent::defaultDisplayOptions();
        // Add permission-based access control.
        $display_options['access']['type'] = 'perm';
        $display_options['access']['options']['perm'] = 'access user profiles';
        // Remove the default fields, since we are customizing them here.
        unset($display_options['fields']);
        
        /* Field: User: Name */
        $display_options['fields']['name']['id'] = 'name';
        $display_options['fields']['name']['table'] = 'users_field_data';
        $display_options['fields']['name']['field'] = 'name';
        $display_options['fields']['name']['entity_type'] = 'user';
        $display_options['fields']['name']['entity_field'] = 'name';
        $display_options['fields']['name']['label'] = '';
        $display_options['fields']['name']['alter']['alter_text'] = 0;
        $display_options['fields']['name']['alter']['make_link'] = 0;
        $display_options['fields']['name']['alter']['absolute'] = 0;
        $display_options['fields']['name']['alter']['trim'] = 0;
        $display_options['fields']['name']['alter']['word_boundary'] = 0;
        $display_options['fields']['name']['alter']['ellipsis'] = 0;
        $display_options['fields']['name']['alter']['strip_tags'] = 0;
        $display_options['fields']['name']['alter']['html'] = 0;
        $display_options['fields']['name']['hide_empty'] = 0;
        $display_options['fields']['name']['empty_zero'] = 0;
        $display_options['fields']['name']['plugin_id'] = 'field';
        return $display_options;
    }

}

Classes

Title Deprecated Summary
Users Tests creating user views with the wizard.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.