Arlo

Event template related shortcodes

The following shortcodes can be used in the Arlo for WordPress plugin.

[arlo_event_template_list_item][/arlo_event_template_list_item]

The shortcode represents an event template

Attributes

  • category (string): A category "slug" (which is usually the url of the category) can be passed to the shortcode and will be used as a base/root category.
  • limit (int): The default item per page can be overridden with this attribute. The default value is inherited from the WordPress "Posts per page" setting.
  • show_only_at_bottom (bool): If set to "true", the event templates list will only be shown at the bottom/leaf category.
  • show_child_elements (bool): If set to "true", all the templates will be shown from all the categories under the base/root category.
  • group (string): If the attribute is set, the [arlo_group_divider] shortcode can be used within the shortcode
    • "category": The templates list will be grouped by category.
    • "alpha": the templates list will be grouped by the templates' first (alphanumerical) character.

If the attributes are used in the [arlo_event_template_list_item] shortcode, it's necessary to add those with the same value to the [arlo_event_template_list_pagination] for the correct count of the items.

Must be used in the "Catalogue" or "Schedule" template.

[arlo_event_template_list_pagination]

The shortcode will be replaced to a pager related to the template list. It uses the default paging function of the WordPress site.

Attributes

  • category (string): A category "slug" (which is usually the url of the category) can be passed to the shortcode and will be used as a base/root category.
  • limit (int): The default item per page can be overridden with this attribute. The default value is inherited from the WordPress "Posts per page" setting.
  • show_only_at_bottom (bool): If set to "true", the event templates list will only be shown at the bottom/leaf category.
  • show_child_elements (bool): If set to "true", all the templates will be shown from all the categories under the base/root category.

If the attributes are used in the [arlo_event_template_list_item] shortcode, it's necessary to add those with the same value to the [arlo_event_template_list_pagination] for the correct count of the items.

Must be used in the "Catalogue" template.

[arlo_schedule_pagination]

The shortcode will be replaced to a pager related to the template list. It uses the default paging function of the WordPress site.

Attributes

  • category (string): A category "slug" (which is usually the url of the category) can be passed to the shortcode and will be used as a base/root category.
  • limit (int): The default item per page can be overridden with this attribute. The default value is inherited from the WordPress "Posts per page" setting.
  • show_only_at_bottom (bool): If set to "true", the event templates list will only be shown at the bottom/leaf category.
  • show_child_elements (bool): If set to "true", all the templates will be shown from all the categories under the base/root category.

If the attributes are used in the [arlo_event_template_list_item] shortcode, it's necessary to add those with the same value to the [arlo_schedule_pagination] for the correct count of the items.

Must be used in the "Schedule" template.

[arlo_event_template_code]

Represents the template's code.

Must be used within the [arlo_event_template_list_item] or the [arlo_upcoming_list_item] or the [arlo_suggest_templates] shortcodes or in the "Event" template.

[arlo_event_template_name]

Represents the template's name.

Must be used within the [arlo_event_template_list_item] or the [arlo_upcoming_list_item] or the [arlo_suggest_templates] shortcodes or in the "Event" template.

Represents the URL of the template within the WordPress instance.

Must be used within the [arlo_event_template_list_item] or the [arlo_upcoming_list_item] or the [arlo_event_template_list_item] or the [arlo_suggest_templates] shortcodes or in the "Event" template.

Represents the URL of the template in Arlo. For more information, please view the ViewUri section at the documentation of the PUB API.

Must be used within the [arlo_event_template_list_item] or the [arlo_upcoming_list_item] or the [arlo_suggest_templates] shortcodes or in the "Event" template.

[arlo_event_template_advertised_duration]From: v2.4

Represents the given advertised duration of the template in Arlo. For more information, please view the AdvertisedDuration section at the documentation of the PUB API.

Must be used within the [arlo_event_template_list_item] or the [arlo_upcoming_list_item] shortcodes or in the "Event" template.

[arlo_event_template_advertised_price]From: v3.9

Represents the cheapest price among the best advertised offers of the template and its scheduled events in Arlo. It will search among all scheduled events and online activities. Discounts are applied. If one is free, it will show "Free" or the given text in the Settings. For more information about best offers, please view the BestAdvertisedOffers section at the documentation of the PUB API.

Attributes

  • showfrom (bool): If set to "false", a "From" text won't be displayed before the price when there is more than 1 price.
    Default: "true"
  • showtaxsuffix (bool): If set to "false", a tax suffix text like "incl. GST" or "excl. VAT" won't be displayed after the formatted price.
    Default: "true"

Must be used within the [arlo_event_template_list_item] or the [arlo_upcoming_list_item] shortcodes or in the "Event" template.

[arlo_event_template_advertised_presenters]From: v3.9

Represents the advertised presenters for that template. For more information, please view the AdvertisedPresenters section at the documentation of the PUB API. Advertised presenter will not appear when not displayed on website.

Must be used within the [arlo_event_template_list_item] or the [arlo_upcoming_list_item] shortcodes or in the "Event" template.

[arlo_event_template_summary]

Represents the template's summary field.

Must be used within the [arlo_event_template_list_item] or the [arlo_upcoming_list_item] or the [arlo_suggest_templates] shortcodes or in the "Event" template.

[arlo_event_template_credits]From: v3.9

Represents the credits such as the professional development hours and points at the template level if any. For more information, please view the Credits section at the documentation of the PUB API.

Attributes

  • text (string): Defines the output for each credit with placeholder elements
    • {%label%}: The type of credits. For example: "PD points"
    • {%points%}: The value for the credits. For example: "20"
    Default: "{%label%}: {%points%}"
  • layout (string): Defines the layout of the output.
    • "list": Outputs a HTML list
    Default: list

Must be used within the [arlo_event_template_list_item] or the [arlo_upcoming_list_item] shortcodes or in the "Event" template.

[arlo_event_template_register_interest]

If there is no event, it outputs the No event on template text.
If Lead generation is enabled, it also outputs a link to the register interest form.

Must be used within the [arlo_event_template_list_item] template or in the "Event" template.

[arlo_event_template_register_private_interest]From: v3.8

Represents the link to the "register interest in a private event" form.

Similar to [arlo_suggest_private_datelocation].
The link will be displayed when the following conditions are met:

Attributes

  • text (int): The text to be displayed instead of the default one.
    All the text is used as the text of the link unless 2 %s sequences are used to delimit the start and end of the link.
    Default: "Want to run this event in-house? %s Enquire about running this event in-house %s"

Must be used within the "Event" template.

[arlo_content_field_item][/arlo_content_field_item]

Represents the template's "Website page content" fields like "Description", "Outcomes", "Prerequisites" etc.

Attributes

  • fields (string): Can be used to define which content field will be shown. It is a comma separated list of the exact match of the name of the content field.

Must be used within the [arlo_event_template_list_item] or the [arlo_upcoming_list_item] shortcodes and in the "Event" template.

Example

[arlo_content_field_item fields="Prerequisites"]
    [arlo_content_field_name wrap="<h5>%s</h5>"]
    [arlo_content_field_text]
[/arlo_content_field_item]

It will output the following HTML code

                <h5>Prerequisites</h5>
                The given rich text under "Prerequisites".
            

[arlo_content_field_name]

Represents the name of the content field.

Must be used within the [arlo_content_field_item] shortcode.

[arlo_content_field_text]

Represents the value of the content field.

Must be used within the [arlo_content_field_item] shortcode.

[arlo_event_template_filters]

Creates different dropdowns to filter the templates list.

Attributes

  • filters (string): Can be used to define which filter dropdown will be shown. It is a comma separated list with the following items:
    • "category": a dropdown with all the available categories (nested).
    • "location": a dropdown with all the available locations.
    • "delivery": a dropdown to filter the events by its delivery, with the following options:
      • "Online (Webinar)": Online events
      • "Workshop": Offline events
    • "templatetag": a dropdown with all the available template tags.
    • "state": From: v2.1.6 a dropdown with all the available states.
  • resettext (string): The displayed text of the reset button.
  • buttonclass (string): a CSS class name for the reset button.

Must be used in the "Catalogue" template.

[arlo_schedule_filters]

Creates different dropdowns to filter the templates list.

Attributes

  • filters (string): Can be used to define which filter dropdown will be shown. It is a comma separated list with the following items:
    • "category": a dropdown with all the available categories (nested).
    • "location": a dropdown with all the available locations.
    • "delivery": a dropdown to filter the events by its delivery, with the following options:
      • "Online (Webinar)": Online events
      • "Workshop": Offline events
    • "templatetag": a dropdown with all the available template tags.
    • "state": From: v2.1.6 a dropdown with all the available states.
  • resettext (string): The displayed text of the reset button.
  • buttonclass (string): a CSS class name for the reset button.

Must be used in the "Schedule" template.

[arlo_event_template_tags]From: v2.1.6

Creates a list of tags which are associated to the template

  • 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_template_list_item] or the [arlo_upcoming_list_item] shortcodes or in the "Event" template.

[arlo_template_region_selector] From: v2.3

Creates a select drop down with the available regions. If there is no region specified, it returns nothing.

Must be used within the [arlo_event_template_list] shortcode or in the "Event" template or in the "Online Activities" template.

[arlo_template_search_region_selector] From: v2.3

Creates a select drop down with the available regions. If there is no region specified, it returns nothing.

Must be used within the [arlo_event_template_search_list] shortcode.

[arlo_event_template_rich_snippet]From: v3.3

Outputs the rich snippet data for the event template.

Attributes

  • link (string): it can be one of the following
    • "permalink": Link to the event template in the WordPress instance
    • "viewuri": Link to the event template in Arlo
    Default: "permalink"

Must be used within the [arlo_event_template_list_item] or the [arlo_upcoming_list_item] or the [arlo_suggest_templates] shortcodes or in the "Event" template.