Creating a custom layout template for the plugin

The Quick Guide

1. Create a folder called widget-for-eventbrite-api in your child theme
   ( if you don’t have a child theme, you can place this folder in wp-content )
2. Copy a layout from the plugin template folder and rename your file keeping the name structure layout_{yourtemplatename}.php
   
   

   You can choose from the list of available layout templates to copy from the plugin:

   • freemius-premium
     • templates__free
     • templates__premium_only
       • layout_1.php
       • layout_widget.php
       • layout_cal.php
       • layout_cal_list.php
       • layout_grid.php
       • layout_slider.php
       • layout_venue.php
3. Use the new template in your shortcode e.g. [wfea layout="yourtemplatename"]

You can use existing template parts and loops or create your own. You can also override templates using the same file names, your files will take precedence over the plugin.

Understanding the Template Structure

Display Eventbrite events is broken down into three different categories: Layout, Loop, Parts

A custom layout will consist of the following:

• 1 layout file
• 1 loop file
• zero to many part files

Layout (REQUIRED)

A layout file must always exist in your widget-eventbrite-api folder. Otherwise, your custom layout won't run.

This is the file the plugin looks for whenever the layout property is used in the shortcode.

[wfea layout="yourtemplatename"]

The above shortcode will try to find the layout_yourtemplatename.php

A layout template will have the following code. Change the values accordingly.

// This will be the class name for the event list container.
$data->event->layout_class = 'your-class-name-here'; 

// change the value to your custom layout name.
$data->event->layout_name = 'yourtemplatename';
		

Loop

This file is responsible for the display on each event. This is where you most-likely do the editing if you want to modify the html structure for each event.

The loop file is located under the loops folder. The filename should be preceeded by the word "loop_" followed by the custom template name. i.e loop_yourtemplatename.php

Parts

Parts folder is consists of multiple files. Each file contains event detail like Event header, date, venue, prices, availability, etc.

You don't necessarily need to create each files from the parts folder into your widget-eventbrite-api folder unless you want to make changes.

Here's a list of the available part files from the plugin.

You can call a template file according to their filename using the `get_template_part` method from the $data->template_loader object.

echo $data->template_loader->get_template_part('availability');

Template Override

There are instances where you want to change something from the plugin's existing file.

For example, you want to make changes on the date.php file. Below is how the current template structure of the plugin looks like. All you have to do is copy the date.php file and paste it on your widget-for-eventbrite-api folder with the same folder structure.

After pasting the file to your widget-for-eventbrite-api folder. It should now look like this.

You should now be able to freely make any changes to the date.php file.

Please also note that the template override can be done to any template files including the layouts and loops.

Data Structure

This section will help you understand the data structure that is passed to the template. The event data is logically held withing the $data->events object.

$data->events contains the list of events. This works similarly to WordPress posts. To access the individual event data, we'll have to loop through the object.

while ( $data->events->have_posts() ) {
    $data->events->the_post();
    
    // You can access all the Eventbrite event information
    // using the object $data->evens->post
    echo $data->events->post->post_title 

    // You can use var_dump() to see all the available properties
    var_dump($data->events->post);
}
    

Below is a sample data coming from Eventbrite API. The following data can be access through $data->events->post

• Data
• Layout Preview

Loading…

Apr 26th

Online Workshop Live: Any questions Display Eventbrite WordPress Plugin

Register »

An unstructured online wordshop to help you understand how best to use the Display Eventbrite Events WordPress plugin. Read More »

April 26, 2024, 4:00 pm - 4:45 pm