Using anchor links to open accordions and tabs in Divi – from another page!

The most popular article on my blog so far (by way of comments on it) is the one on Using anchor links to open accordions and tabs in Divi. It’s so popular that when the demo page broke recently I even had a few people comment to ask if the process still worked with newer versions of Divi (it does, by the way).

It being the most popular article, the most popular question I get about it is “How do I link to and open an accordion or tab, from an external page?”. Well, today I share that solution.

Before we begin – This article is going to be a little more advanced than my usual Divi posts. This is because it is going to require delving into the world of PHP and WordPress action hooks. For the purposes of this article I am not going to delve too deeply into those topics, so I do suggest reading the relevant documentation on WordPress.org. Also, for the purposes of this article, you are going to need to know how to include PHP into your WordPress site (either via a Divi child theme or a plugin). If you are new to PHP I recommend reading my Child Theme series, especially the article on Making child themes part of your development best practice. For this article, we’ll use a child theme, because it’s the easiest way.

Ok, all caught up? Good, let’s begin!

Preparation: Understand Query Strings

The first thing you need to understand is query strings. Query strings are not something you see a lot of lately (as pretty permalinks are the norm) but they are what existed before permalinks were made popular. Query strings look something like this:

 http://mycooldomain.com/?post_name=my-cool-article 

See how I am specifying that post_name is equal to my-cool-article after the question mark sign? This is a query string. In this string I am passing the variable post_name and giving it a value of my-cool-article. Once the url before the query string loads (in this case just the home page of the domain) I can check for that variable using the global PHP $_GET variable array and, if it exists, do something with it.

 
$passed_post_name = $_GET['post_name'];
// do something with the $passed_post_name variable

In order to open a specific tab or accordion on page A from page B, I need to setup my anchor links on page B to point to page A, but those links should also include a query string variable, in this instance the name of the accordion or tab item I want to open.

So, for the purposes of this topic my query string will something look like this

 ?et_open_accordion=et_pb_accordion_item_1 

or

 ?et_open_tab=et_pb_tab_1 

You’ll see that I am passing the class identifier of the accordion or tab item to open as the value. (more on this later)

Step 1: Making some jQuery changes

Let’s first take a look at the accordion ‘open’ snippet I posted in the original article:

jQuery(function ($) {
  //accordion
  $('#open-accordion-dance a').on('click', function(event){
    $('#my-accordian .et_pb_accordion_item_1 .et_pb_toggle_title').click();
    $("html, body").animate({ scrollTop: $('#my-accordian').offset().top }, 1000);
  });
  //tab
  $('#open-tab-dance a').on('click', function(event){
    $('#my-tabs .et_pb_tab_1 a').click();
    $("html, body").animate({ scrollTop: $('#my-tabs').offset().top }, 1000);
  });
});

The important thing to look at is the css class identifier for the accordion or item we’re triggering the click on, in this case .et_pb_accordion_item_1 or .et_pb_tab_1. See how this is the same as the value being passed in the query string above. What we need to do now is to be able to specify that value as a JavaScript variable somehow and pass that variable into the JavaScript, to trigger the click of our selected accordion item, when the page loads.

The second thing we will need to do is make sure that this code only fires, once the entire document has loaded. Currently it waits for you to click a link on the same page, but now we’ll be loading the page with the accordion or tab content and then triggering the click.

The change to the JavaScript looks like this:

jQuery(function ($) {
  $( document ).ready(function() {
    // accordion
    if (typeof openers.accordion !== 'undefined') {
      var accordion_element = '#my-accordian .' + openers.accordion + ' h5.et_pb_toggle_title';
      $(accordion_element).click();
      $("html, body").animate({ scrollTop: $('#my-accordian').offset().top }, 1000);
    }
    // tab
    if (typeof openers.tab !== 'undefined') {
      var tab_element = '#my-tabs .' + openers.tab + ' a';
      $(tab_element).click();
      $("html, body").animate({ scrollTop: $('#my-tabs').offset().top }, 1000);
    }
  });
});

Note how I have changed the et_pb_accordion_item_1 and et_pb_tab_1 to openers.accordion and openers.tab and instead of those variables being inside the class selector string they are being concatenated to the string (see, I told you this was a little more advanced). I’m also wrapping the entire thing inside a $( document ).ready(function() {} and removing the on(“click”) event handlers and checking if there is an instance of either openers.accordion or openers.tab. If either exists it will fire the relevant ‘open and animate to’ code.

 

Step 2: Mix in some PHP

Right, so now that we have this updated JavaScript we need to setup those openers variables, based on the query string. Do to this we need to do two things a) enqueue the JavaScript in the child theme and b) pass some PHP variables to the JavaScript. To achieve this we’ll put all our PHP code into a functions.php file of a child theme.

Instead of using the Divi Theme Options Code Integration tab for the JavaScript, we need to save it in a file in our child theme and hook a function into the wp_enqueue_scripts action hook (the same one used to enqueue child theme CSS). It looks something like this:

function my_theme_enqueue_scripts() {
wp_register_script( 'some_handle', 'path/to/myscript.js' );
wp_enqueue_script( 'some_handle' );
}
add_action( 'wp_enqueue_scripts', 'my_theme_enqueue_scripts' );

We also need to make the PHP variable available to the script. This is done by using the wp_localize_script function, which allows you to pass any variable from PHP to the JavaScript script you are enqueuing using wp_localize_script.

function my_theme_enqueue_scripts() {
    wp_register_script( 'some_handle', 'path/to/myscript.js' );
    $variable_array = array(
        'my_javascript_variable' => 'some value'
    );
    wp_localize_script( 'some_handle', 'javscript_object_name', $translation_array );
    wp_enqueue_script( 'some_handle' );
}
add_action( 'wp_enqueue_scripts', 'my_theme_enqueue_scripts' );

What this does is pass a PHP array of variables ( $variable_array  ) into the JavaScript layer as a JavaScript object ( javscript_object_name ) and makes them available to use in the JavaScript layer.

Finally we’ll need to capture the variables passed from the query string. That looks something like this:

$variable_array = array(); 
if( isset( $_GET['et_open_accordion'] ) ){ 
  $variable_array['accordion'] = $_GET['et_open_accordion']; 
} 
if( isset( $_GET['et_open_tab'] ) ){ 
  $variable_array['tab'] = $_GET['et_open_tab']; 
}

There are also some other things we need to setup, like defining path urls for enqueing files and setting up the Divi parent stylesheets. Again I’m not going to go into too much detail, but the final functions.php file looks like this:

define( 'PARENT_THEME_URL', trailingslashit( get_template_directory_uri( ) ) );
define( 'CHILD_THEME_URL', trailingslashit( get_stylesheet_directory_uri( ) ) );

function divi_child_theme_enqueue_styles() {

	$parent_style = 'divi-style'; // This is the 'parent-style'.

	wp_enqueue_style( $parent_style, PARENT_THEME_URL . 'style.css' );
	wp_enqueue_style( 'divi-child-style', CHILD_THEME_URL . 'style.css', array( $parent_style ) );

	$functions_script = 'divi-child-functions';

	$data = array();

	if( isset( $_GET['et_open_accordion'] ) ){
		$data['accordion'] = $_GET['et_open_accordion'];
	}

	if( isset( $_GET['et_open_tab'] ) ){
		$data['tab'] = $_GET['et_open_tab'];
	}

	wp_register_script( $functions_script, CHILD_THEME_URL . 'functions.js', array( 'jquery' ), '1.0', true );
	wp_localize_script( $functions_script, 'openers', $data );
	wp_enqueue_script( $functions_script );

}
add_action( 'wp_enqueue_scripts', 'divi_child_theme_enqueue_styles' );

Step 4: Putting it all together.

So, you have your functions.php file, retrieving the passed variables, setting up the javascript variables and enqueing the relevant javascript file to make it all work. All you have to do now is create a page with anchors that link to the correct location, including your query strings. And we’re all set.

To make it easier for you to test out, I’ve create a very basic Divi child theme, including all the above code, that you can just install, configure and use out of the box. You can grab this child theme demo from the GitHub page.

One thing to note, this article and child theme are for the purposes of explaining the basics of linking to open tabs or accordions. In the real world you should be considering escaping the query variables in the PHP to ensure no one injects any dodgy code into your site. This article is a good place to start.

Happy Divi-ing.

Update: Thanks to Nathan Duvall for pointing out how to manage this with Divi toggles.

(function($){
    $(window).load(function(){
        var et_hash = window.location.hash;
        if(window.location.hash) {
        $( '.et_pb_toggle' + et_hash ).removeClass('et_pb_toggle_close').addClass('et_pb_toggle_open');
    }
});
})(jQuery)

Credit: https://bernadot.com/divi-theme-how-to-open-toggled-modules-with-a-url-hashtag/

Filed under: Development, Divi, WordPressTagged with: , ,

31 Comments

  1. Thoughts on making this into a plugin? So that non-developers could just add the appropriate tab URL to their href, and have it “just work”?

  2. Another great article, Jonathan! Thanks for the reminder about wp_localize_script(). It’s a very powerful but underutilized development tool for sure.

    • Thanks Terry, glad you found it useful.

      In my old non WP days we used to have to inject the JavaScript variable by echoing out the php variable (something like this)

      var js_var = [php echo $php_var ]

      Very nasty 😉

  3. Hi Jonathan – Will this work for say click anchor link from one module and have it open a different module on the same page, not different page?

  4. Great article, Jonathan! I was actually looking for something similar, but for toggles. Apparently the process is a little easier with those vs. accordions/tabs. For anyone else needing this functionality for tabs, it’s just a matter of giving each toggle a unique ID, copy/pasting this code into the integration tab and then setting up the link.

    (function($){
    $(window).load(function(){
    var et_hash = window.location.hash;
    if(window.location.hash) {
    $( ‘.et_pb_toggle’ + et_hash )
    .removeClass(‘et_pb_toggle_close’)
    .addClass(‘et_pb_toggle_open’)
    }
    });
    })(jQuery)

    Credit: https://bernadot.com/divi-theme-how-to-open-toggled-modules-with-a-url-hashtag/

    • Thanks Nathan, glad you found the article useful. You may or may not remember this, but it was you who first introduced me to the Facebook Divi Communities 😉

  5. Hi there

    Great article although I am worried I may have missed something as it isn’t quite working how I expected, both links I have put in just go to the same open tab.(I am not very familiar with scripting so if you could point me in the right direction that would be great).

    I basically have 2 top level main menu items which when clicked I would like to open up not only the relevant page but also open the correct highlighted tab.

    I have implemented from the above tutorial, i.e.:

    1) Added the code to a functions file in the child theme:

    <?php

    add_action( 'wp_enqueue_scripts', 'my_enqueue_assets' );

    function my_enqueue_assets() {

    wp_enqueue_style( 'parent-style', get_template_directory_uri().'/style.css' );

    }

    define( 'PARENT_THEME_URL', trailingslashit( get_template_directory_uri( ) ) );
    define( 'CHILD_THEME_URL', trailingslashit( get_stylesheet_directory_uri( ) ) );

    function divi_child_theme_enqueue_styles() {

    $parent_style = 'divi-style'; // This is the 'parent-style'.

    wp_enqueue_style( $parent_style, PARENT_THEME_URL . 'style.css' );
    wp_enqueue_style( 'divi-child-style', CHILD_THEME_URL . 'style.css', array( $parent_style ) );

    $functions_script = 'divi-child-functions';

    $data = array();

    if( isset( $_GET['et_open_accordion'] ) ){
    $data['accordion'] = $_GET['et_open_accordion'];
    }

    if( isset( $_GET['et_open_tab'] ) ){
    $data['tab'] = $_GET['et_open_tab'];
    }

    wp_register_script( $functions_script, CHILD_THEME_URL . 'functions.js', array( 'jquery' ), '1.0', true );
    wp_localize_script( $functions_script, 'openers', $data );
    wp_enqueue_script( $functions_script );

    }
    add_action( 'wp_enqueue_scripts', 'divi_child_theme_enqueue_styles' );

    2) Given the tabs module the name my-tabs in the custom css field

    3) Added custom links to my main navigation, (nb I am working locally) i.e.:
    a) Sunday Worship points to: http://stjames.dev/community-outreach/#my-tabs|0
    b) Sunday School points to: http://stjames.dev/community-outreach/#my-tabs|4

    However at the moment when I click on the menu items they go to the right page (community-outreach) which is great, however they both only show the first tab opened (Sunday Worship), darn!

    My Questions:

    1) How do I get the second link to open the correct tab, please? I think I missed something somewhere 🙂
    2) Also will the links also work ok when they are accessed from the page with the tabs too?

    Thanks so much

      • Hi Jonathan, thanks for getting back to me so quickly and pointing that out for me – I have now got it working correctly.

        One more quick question when it goes to the correct tab the page scrolls down a little bit thus obscuring the highlighted tab name – it looks like the page scrolls to the top and then hides behind the primary navigation header – is there a way to avoid that at all?

        Thanks so much

        • Hi again – no problem, I think I have worked it out, I removed the:

          $(“html, body”).animate({ scrollTop: $(‘#my-tabs’).offset().top }, 1000);

          bit and the scroll has gone – thanks for the great tutorial 🙂

          Izzy

  6. thank you so much for this. this is brilliant! cheers 🙂

    • My pleasure Regina, I am glad it works for you.

  7. When linking to multiple different accordian items, each consecutive one begins to become a little more offset from the top. See my example (open each link in a new tab and compare): http://southeasttax.wpengine.com/linking-page/

    Any solution for this?

    • Hi Zac

      The code that does the auto scroll is this line

      $(“html, body”).animate({ scrollTop: $(‘#my-accordian’).offset().top }, 1000);

      Basically that is scrolling the window to the top of the accordion. So you could change it to scroll to the top of the opened accordion item by appending the class selector variable for the opened accordion item.

      $(“html, body”).animate({ scrollTop: $(‘#my-accordian .’ + openers.accordion ).offset().top }, 1000);

      Let me know how it goes.

      • what do we have to change to do the same for the “tab version”

  8. Nope, looks like it didn’t change anything..

  9. Hi Jonathan,
    Its working well on my tab case.
    Thanks a lot for share this article and help.

  10. Great article Jonathan!
    Building in this functionality seems to be to be a fundamental requirement if you have content in Tabs, Accordions and Toggle modules. However, the procedure that you outline is a little outside my capabilities!
    Elegant Themes appear to be neatly sidestepping the issue at the moment, so wouldn’t it be nice if some one could develop a plugin (I would gladly pay for it!), or a complete step by step idiots tutorial?

    • Hi Chris, thanks for the feedback.

      I am actually in the process of building this into a plugin for general release next week, watch this space 😉

      Regards

      • Fantastic! That’s the best news I have heard in a long time!
        I nominate you for entry into the WP Hall of Fame! 😉

      • Any update on the plugin?

  11. Hi Jonathan,
    No pressure!
    Are you any closer to launching the plugin?
    Cheers,
    Chris

  12. At this stage the plugin is still in development, I have to focus on work that pays the bills, but I will wrap it up as soon as I can.

    • I’m familiar with that little dilemma!
      If you need a hand with any beta testing, just let me know and I will be happy to help.
      Cheers,
      Chris

  13. Thanks much Jonathan for this solution, which I really wanted to learn.

    Just one thing is I am little bit slow on getting this.

    How about putting all the jquery scripts, php, and the html, in a zip. I believe by running these files and then studying them by tests will help me on understanding this most looked for solution you have provided.

    Much appreciated for this.

    Thanks,

  14. Hello,
    Thanks so much for this!

    On the topic of security, since we aren’t printing or writing to a database we apparently need be concerned with the data we are getting from the url (key, value pairs) via the “$_GET[‘et_open_accordion’]” and $_GET[‘et_open_tab’], correct?

    It seems to me that this WordPress function is a close fit:

    https://codex.wordpress.org/Function_Reference/sanitize_title_with_dashes

    as it: “Limits the output to alphanumeric characters, underscore (_) and dash (-). Whitespace becomes a dash.”

    So, if we do:
    sanitize_title_with_dashes( $_GET[‘et_open_tab’] )
    sanitize_title_with_dashes( $_GET[‘et_open_accordion’] )

    it would seem that I’m covering the bases, correct?

    • Sure, that function would be fine. To be honest, because of how the parameter is only being used to setup some jQuery functionality, I don’t really think you even need to perform any data sanitisation. Just doing something like checking to make sure that the correct string has been passed would be sufficient


      $parameter = $GET['et_open_tab'];
      if ( strpos( $parameter, 'et_pb_tab_' ) !== FALSE ) {
      // setup the javascript object
      }

  15. Jonathan,
    Thank you.

    I would have been happy if you had just made a plugin; now I’ve learned quite a bit and am understanding what is being done so, I’m ecstatic!

    Love your site and approach!


Add a Comment

Your email address will not be published. Required fields are marked *

Comment *

Name *
Email *
Website