You are here

function view::execute_display in Views (for Drupal 7) 6.2

Same name and namespace in other branches
  1. 6.3 includes/view.inc \view::execute_display()
  2. 7.3 includes/view.inc \view::execute_display()

Execute the given display, with the given arguments. To be called externally by whatever mechanism invokes the view, such as a page callback, hook_block, etc.

This function should NOT be used by anything external as this returns data in the format specified by the display. It can also have other side effects that are only intended for the 'proper' use of the display, such as setting page titles and breadcrumbs.

If you simply want to view the display, use view::preview() instead.

File

includes/view.inc, line 954
view.inc Provides the view object type and associated methods.

Class

view
An object to contain all of the data to generate a view, plus the member functions to build the view query, execute the query and render the output.

Code

function execute_display($display_id = NULL, $args = array()) {
  if (empty($this->current_display) || $this->current_display != $this
    ->choose_display($display_id)) {
    if (!$this
      ->set_display($display_id)) {
      return FALSE;
    }
  }
  $this
    ->pre_execute($args);

  // Execute the view
  $output = $this->display_handler
    ->execute();
  $this
    ->post_execute();
  return $output;
}