You are here

public function ViewExecutable::preview in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/views/src/ViewExecutable.php \Drupal\views\ViewExecutable::preview()

Preview the given display, with the given arguments.

To be called externally, probably by an AJAX handler of some flavor. Can also be called when views are embedded, as this guarantees normalized output.

This function does not do any access checks on the view. It is the responsibility of the caller to check $view->access() or implement other access logic. To render the view normally with access checks, use views_embed_view() instead.

File

core/modules/views/src/ViewExecutable.php, line 1538
Contains \Drupal\views\ViewExecutable.

Class

ViewExecutable
Represents a view as a whole.

Namespace

Drupal\views

Code

public function preview($display_id = NULL, $args = array()) {
  if (empty($this->current_display) || !empty($display_id) && $this->current_display != $display_id) {
    if (!$this
      ->setDisplay($display_id)) {
      return FALSE;
    }
  }
  $this->preview = TRUE;
  $this
    ->preExecute($args);

  // Preview the view.
  $output = $this->display_handler
    ->preview();
  $this
    ->postExecute();
  return $output;
}