function ViewExecutable::chooseDisplay

Same name and namespace in other branches
  1. 11.x core/modules/views/src/ViewExecutable.php \Drupal\views\ViewExecutable::chooseDisplay()
  2. 10 core/modules/views/src/ViewExecutable.php \Drupal\views\ViewExecutable::chooseDisplay()
  3. 8.9.x core/modules/views/src/ViewExecutable.php \Drupal\views\ViewExecutable::chooseDisplay()

Gets the first display that is accessible to the user.

Parameters

array|string $displays: Either a single display id or an array of display ids.

Return value

string The first accessible display id, at least default.

File

core/modules/views/src/ViewExecutable.php, line 750

Class

ViewExecutable
Represents a view as a whole.

Namespace

Drupal\views

Code

public function chooseDisplay($displays) {
  if (!is_array($displays)) {
    return $displays;
  }
  $this->initDisplay();
  foreach ($displays as $display_id) {
    if ($this->displayHandlers
      ->get($display_id)
      ->access($this->user)) {
      return $display_id;
    }
  }
  return 'default';
}

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