views_embed_view

Versions

6 – 7

views_embed_view($name, $display_id = 'default')

Embed a view using a PHP snippet.

This function is meant to be called from PHP snippets, should one wish to embed a view in a node or something. It's meant to provide the simplest solution and doesn't really offer a lot of options, but breaking the function apart is pretty easy, and this provides a worthwhile guide to doing so.

Note that this function does NOT display the title of the view. If you want to do that, you will need to do what this function does manually, by loading the view, getting the preview and then getting $view->get_title().

Parameters

$name The name of the view to embed.

$display_id The display id to embed. If unsure, use 'default', as it will always be valid. But things like 'page' or 'block' should work here.

... Any additional parameters will be passed as arguments.

Code

contributions/views/views.module, line 1151

<?php
function views_embed_view($name, $display_id = 'default') {
  $args = func_get_args();
  array_shift($args); // remove $name
  if (count($args)) {
    array_shift($args); // remove $display_id
  }

  $view = views_get_view($name);
  if (!$view || !$view->access($display_id)) {
    return;
  }

  return $view->preview($display_id, $args);
}
?>

Post new comment

Your name: *

E-mail: *

The content of this field is kept private and will not be shown publicly.

Homepage:

Subject:

Comment: *

• Allowed HTML tags: <a> <em> <strong> <cite> <code> <ul> <ol> <li> <dl> <dt> <dd>
• Lines and paragraphs break automatically.
• You may post code using <code>...</code> (generic) or <?php ... ?> (highlighted PHP) tags.
• Web page addresses and e-mail addresses turn into links automatically.

More information about formatting options

CAPTCHA

This question is for testing whether you are a human visitor and to prevent automated spam submissions.

What code is in the image?: *

Enter the characters (without spaces) shown in the image.