Simple Views display switch

26 Feb 2015

If you need a simple Views display switch to toggle e.g between a list and a grid display of a view, there are a couple of plug & play options already.

Display Suite and Quick Tabs are modules which provide this functionality but they seem to be quite an overkill for a simple display switch. View modes on the other hand seems to be exactly what is needed, however there is no stable version and the development one did not work for me.

How it needs to work

Our use case dictates that while switching a display, the view needs to retain the exposed filter values and page number. The page will be reloaded, no AJAX magic here.

Views display switch

So let's create our own views display switch. In order to do that you will obviously be needing a view with at least two page displays showing content in different ways. You will also have to put some code into your custom module. If in doubt, refer to the countless other tutorials.

Set up your view

In the view named [view] set the path of [display_1] to e.g [page/grid], the path to [display_2] to e.g [page/list].

Create callback function

Create a simple callback function which will provide the switch in ready-to-be-displayed HTML.

  1. /**
  2.  * Gets HTML output of a switch which will switch between grid and list display of a view.
  3.  */
  4. function [mymodule]_get_views_display_switch() {
  5.  
  6. $switch = l(t('Grid'), '[page/grid]', array(
  7. 'query' => drupal_get_query_parameters(), // This ensures the view will keep filter settings when switching the display.
  8. 'attributes' => array(
  9. 'class' => array('page-grid-switch') // Adding a css class for this link.
  10. )
  11. ));
  12. $switch .= ' | ';
  13. $switch .= l(t('List'), '[page/list]', array(
  14. 'query' => drupal_get_query_parameters(),
  15. 'attributes' => array(
  16. 'class' => array('page-list-switch')
  17. )
  18. ));
  19.  
  20. // Adding CSS class for whole switch.
  21. $switch = "<div class='page-display-switch'>" . $switch . "</div>";
  22. return $switch;
  23. }

Implement views hook

Implement hook_views_pre_view hook to add the switch to the view.

  1. /**
  2.  * Implements hook_views_pre_view().
  3.  */
  4. function [mymodule]_views_pre_view(&$view, &$display_id, &$args) {
  5. if ($view->name == '[view]' && $display_id == '[display1]' || $display_id == '[display_2]') {
  6.  
  7. // Adds a display switch to the header of a view.
  8. // 'footer' as second parameter will add the display switch to the footer of the view instead.
  9. $view->add_item($display_id, 'header', 'views', 'area', array('content' => [mymodule]_get_views_display_switch(), 'format' => 'full_html'));
  10. }
  11. }

This should do it. The l() function will make sure the link is marked active when it's active and drupal_get_query_parameters() makes sure the exposed filters and current page are retained while swichting.

Comments

Wow! This MUST be a module on drupal.org. Why? Because there are really shortage of the modules which are CMS user/visitor centric as the most Drupal modules are built "by engineers for engineers" and actual user experience is overlooked.

I agree there are many modules in the Drupal ecosystem that are hard to grasp without some Drupal site building experience and often PHP experience, however I wouldn't say there is a shortage of easy/user centric modules.

If you added this code as a module on drupal.org, the community would probably point out other modules with similar functionality, or tell you to collaborate on existing modules to add this functionality on top.
That's because there are loads of modules on drupal.org that are too specialized and/or not maintained anymore.

Adding another module to drupal.org for such specialized functionality would mean another name space taken away for a module that only few will use (it's starting to get quite hard to come up with a simple module name not already taken).
Thanks for commenting.

Great code, thank you.

Add new comment

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

Restricted HTML

  • Allowed HTML tags: <a href hreflang> <em> <strong> <cite> <blockquote cite> <code> <ul type> <ol start type> <li> <dl> <dt> <dd> <h4 id> <h5 id> <h6 id>
  • Lines and paragraphs break automatically.
  • Web page addresses and email addresses turn into links automatically.

Get a quote in 24h

Wether a huge commerce system, or a small business website, we will quote the project within 24h of you pressing the following button: Get quote