Arlo

Event related shortcodes

The following shortcodes can be used in the Arlo plugin.

[arlo_event_filters]From: v3.0

Creates different dropdowns to filter the events list on the template page.

Attributes

  • filters (string): Can be used to define which filter dropdown will be shown. It is a comma separated list with the following items:
    • "location": a dropdown with all the available locations.
  • resettext (string): The displayed text of the reset button.
  • buttonclass (string): a CSS class name for the reset button.

Must be used in the "Event" template.

[arlo_event_list][/arlo_event_list]

An iteration over the template's events with the actual dates.

Must be used in the "Event" template.

[arlo_event_list_item]

Represents an event with an exact date.

Must be used within the [arlo_event_list] shortcode.

[arlo_event_name]From: v2.1.6

Represents the event name, which can be different from the template.

Must be used within the [arlo_event_list] or the [arlo_upcoming_list_item] or the [arlo_event_session_list_item] shortcodes.

[arlo_event_code]

Represents the event code.

Must be used within the [arlo_event_list] or the [arlo_upcoming_list_item] or the [arlo_event_session_list_item] shortcodes.

[arlo_event_duration]

Computes the event's duration from the start and end date.

Outputs the following:

  • If the event the start date is the same as the end date
    • If the event is longer than 6 hours, it outputs "1 day"
    • If the event is shorter than 6 hours, it outputs the exact duration with hours and minutes.
  • If the event is longer than a day, but shorter than 7 days, it outputs the number of the days.
  • If the event is longer than 7 days, it outputs the number of the weeks.

Must be used within the [arlo_event_list] or the [arlo_upcoming_list_item] or the [arlo_event_template_list_item] shortcodes.

[arlo_event_price]

It outputs the price of the template with the corresponding tax settings and without any discounts. If the the template is free, it outputs "Free", or the given text for free in the Settings.

Attributes

  • showfrom (bool) From: v2.4: If set to "false", a "From" text won't be displayed before the price.
    Default: "true"

Must be used within the [arlo_event_list] or the [arlo_upcoming_list_item] or the [arlo_event_template_list_item] shortcodes.

[arlo_event_next_running]

Returns a date with a registration link for the next running event. If there is no next running event, it returns a "Register interest" link. The shortcode respects the state of the applied filter.

Attributes

  • format (string) From: v2.3.5: The format of the outputted date. For further reference see the format parameter of PHP's strftime function, which supports localization.
    Default: "%d %b %y"
  • format (string): The format of the outputted date. For further reference see the format parameter of PHP's date function.
    Default: "d M y"
  • limit (int): Defines the number of the dates.
    Default: 1
  • layout (string): Defines the layout of the layout of the output
    • "list": Outputs an HTML list.
  • removeyear (bool): If set to "true", and if the event is in the current year, the year ("Y" or "y") will be removed from the format.
    Default: "true"
  • text (string) From: v2.4: Defines the output of this shortcode with placeholder elements
    • {%date%}: Outputs the date of the next running event, in the given format.
    • {%location%}: Outputs the location of the next running event

Example

[arlo_event_next_running limit="2" text="{%date%}, {%location%}"]

It will output the following HTML code

            <a href="" class="arlo-register">06 Dec, Wellnington</a>, 
            <a href="" class="arlo-register">09 Dec, Auckland</a>
        

Must be used within the [arlo_event_list] or the [arlo_upcoming_list_item] or the [arlo_event_template_list_item] or the [arlo_suggest_templates] shortcodes.

[arlo_event_location]

Represents the event location. It can contain a link, if the event is not an online event, or the associated venue is shown on the website.

Attributes

  • link (string) From: v3.1: it can be one of the following or any valid url
    • "permalink": Link to the venue in the WordPress instance
    • "viewuri": Link to the venue in Arlo
    Default: "permalink"

Must be used within the [arlo_event_list] or the [arlo_upcoming_list_item] or the [arlo_event_session_list_item] shortcodes.

[arlo_event_start_date]

Represents when this event starts.

Attributes

  • format (string) From: v2.3.5: The format of the outputted date. For further reference see the format parameter of PHP's strftime function, which supports localization.
    Default: "%a %I:%M %p"
  • format (string): The format of the outputted date. For further reference see the format parameter of PHP's date function.
    If the event is in the current year, the year ("Y" or "y") will be removed from the format.
    Default: "D g:i A"

Must be used within the [arlo_event_list] or the [arlo_upcoming_list_item] or the [arlo_event_session_list_item] shortcodes.

[arlo_event_end_date]

Represents when this event ends.

Attributes

  • format (string) From: v2.3.5: The format of the outputted date. For further reference see the format parameter of PHP's strftime function, which supports localization.
    Default: "%a %I:%M %p"
  • format (string): The format of the outputted date. For further reference see the format parameter of PHP's date function.
    If the event is in the current year, the year ("Y" or "y") will be removed from the format.
    Default: "D g:i A"

Must be used within the [arlo_event_list] or the [arlo_upcoming_list_item] or the [arlo_event_session_list_item] shortcodes.

[arlo_event_session_description]

Represents the description of the event.

Must be used within the [arlo_event_list] or the [arlo_upcoming_list_item] shortcodes.

[arlo_event_registration]

It outputs a button with the registration link, if the registration is available for the event. If the remaining places is available, it outputs the "X places remaining" text.

If the registration is not available and a registration message is set, it outputs the given registration message.

If the event is full, it outputs the "Event is full" text. If the waiting list feature is enabled, it outputs a link with a "Join waiting list" text.

Must be used within the [arlo_event_list] or the [arlo_upcoming_list_item] shortcodes.

[arlo_event_offers]

Displays an HTML list of the available offers for the event with the corresponding tax settings. If the the event is free, it outputs "Free", or the given text in the Settings.

It also displays the available discounts for the event.

Must be used within the [arlo_event_list] or the [arlo_upcoming_list_item] shortcodes.

[arlo_event_presenters]

Returns a list of presenters for the event.

Attributes

  • layout (string): Defines the layout of the output
    • "list": Outputs an HTML list
    Default: Outputs a comma separated list
  • link (string) From: v3.1: it can be one of the following or any valid url
    • "permalink": Link to the presenter in the WordPress instance
    • "viewuri": Link to the presenter in Arlo
    • "false": No link will be output
    Default: "permalink"

Must be used within the [arlo_event_list] or the [arlo_upcoming_list_item] shortcodes.

[arlo_event_provider]

If the event is with a different event provider, it outputs the name of the provider. If a website url is set for the provider, the name of the provider will be a link to the website of the provider.

Must be used within the [arlo_event_list] or the [arlo_upcoming_list_item] shortcodes.

[arlo_event_delivery]

If the event is an online event, it returns "Online (Webinar)", else it returns "Workshop".

Must be used within the [arlo_event_list] or the [arlo_upcoming_list_item] shortcodes.

[arlo_timezones]

Generates a form with a dropdown selector for timezones to change the event’s timezone.

Must be used within the "Event" template.

[arlo_suggest_datelocation]

Generates a link with the given text which, points to the event template's registerinteresturi.

Attributes

  • text (int): The given text will be displayed as the text of the link.
    Default: "Suggest another date/location"

Must be used within the "Event" template.

t

[arlo_suggest_templates]From: v2.1.5

With this shortcode, you can suggest templates which is related to the current event (template).

Attributes

  • base (string): The connection between the template and the suggested templates
    • "category": The suggested templates will be shown from the same category or categories as the current template
    • "tag": The suggested templates will be shown if they are tagged with the same tag. Must be used with conjuction of the "tagprefix" attribute
    Default: "category"
  • tagprefix (string): If the base is set to "tag", you can define a prefix for a tag, which will be used as a connection between the suggested templates and the current one. The tag has to start with the prefix and the tamplates have to be tagged with that tag.
    Default: "tagprefix"
  • limit (int): Defines the number of the templates to be shown.
    Default: 5
  • onlyscheduled (bool):If this is set to "true", only templates will be shown which has scheduled events
    Default: "false"
  • regionalized: If set to "true", the shortcode will only show templates from the selected region
    Default: "false" From: v2.3

Must be used within the "Event" template and has to be the last shortcode in the template.

[arlo_event_tags]From: v2.1.6

Creates a list of tags which are associated to the event

  • layout (string): Defines the layout of the output
    • "list": Outputs an HTML list
    • "class": Outputs a space separated list of sanitized tags (can be used as an HTML "class" attribute)
      From: v2.2
    Default: Outputs a comma separated list
  • prefix: Can be used in conjuction with the class layout to prefix the class names to avoid css conflicts
    Default: "arlo-"
    From: v2.2

Example

[arlo_event_list]
    [arlo_event_list_item]
        [arlo_event_tags layout="class" prefix="asd-" wrap='<li class="arlo-cf %s">']
        [arlo_event_name]
        </li>
    [/arlo_event_list_item]
[/arlo_event_list]

It will output the following HTML code for every event

                <li class="arlo-cf asd-tag1 asd-tag2">Event name</li>
            

Must be used within the [arlo_event_list_item] shortcode.

[arlo_event_session_list_item]From: v2.1.6

If the event has sessions, this shortcode creates a popup with the sessions information. It uses the jQuery DarkTooltip plugin

  • label (string): Defines the label, which will be shown as a placeholder for the popup
    Default: Session information
  • header (string): Defines the header of the popup
    Default: Sessions

Example

[arlo_event_session_list_item]
    <div class="arlo_session">
        <h6>[arlo_event_name]</h6>
        <div>[arlo_event_start_date format="%a %d %b %H:%M"] - [arlo_event_end_date format="%a %d %b %H:%M"]</div>
        [arlo_event_location]
    </div>
[/arlo_event_session_list_item]

Must be used within the [arlo_event_list_item] shortcode.

[arlo_no_event_text]From: v2.2.1

If there is no event, this shortcode creates a text which was set up at the settings page.

Must be used after the [arlo_upcoming_list_item] or the [arlo_event_template_list_item] shortcodes.

[arlo_event_credits]From: v2.4

It outputs the given credits for the event

Attributes

  • layout (string): Defines the layout of the output.
    • "list": Outputs an HTML list
    Default: list

Must be used within the [arlo_event_list] shortcode.