Arlo home

Venue related shortcodes

These shortcodes show your Arlo venues: a paged list of venues, and the name, address, map, directions, parking information and links of one venue.

They work with one venue at a time. That venue is the one being shown by [arlo_venue_list_item] in the Venues list template, the venue being viewed in the Venue template, or the venue of each event inside [arlo_event_list_item] (Event template) and [arlo_upcoming_list_item] (Upcoming events template). The venue list page itself is added with [arlo_venue_list].

The HTML shown for each shortcode is what the plugin outputs, with line breaks and indentation added for readability. Names, addresses and URLs are examples.

Contents

Quick start

A minimal Venues list template. It shows six venues a page, each with a map, a linked name and the address, followed by the page links:

[arlo_venue_list_item limit="6"]
  <div class="venue">
    [arlo_venue_map height="175" width="400"]
    <h2>[arlo_venue_permalink wrap="<a href='%s'>"][arlo_venue_name]</a></h2>
    [arlo_venue_address layout="string" items="line1,line2,suburb,city,state,post_code,country"]
  </div>
[/arlo_venue_list_item]
<div class="arlo-pager">[arlo_venue_list_pagination limit="6"]</div>

Rendered as HTML:

<div class="venue">
  <iframe src="https://www.google.com/maps/embed/v1/place?q=…" height="175" width="400" …></iframe>
  <h2><a href="https://example.com/venues/12-harbour-centre/">Harbour Centre</a></h2>
  1 Quay Street<br> Auckland, Auckland 1010 <br> New Zealand
</div>
…
<div class="arlo-pager">
  <span aria-current="page" class="page-numbers current">1</span>
  <a class="page-numbers" href="https://example.com/venues/page/2/">2</a>
  <a class="next page-numbers" href="https://example.com/venues/page/2/">Next »</a>
</div>

A minimal Venue template, for one venue:

<h1>[arlo_venue_name]</h1>
[arlo_venue_direction wrap="<a target='_blank' href='%s'>Get directions</a>"]
[arlo_venue_address]
[arlo_venue_map height="300" width="600"]
[arlo_venue_directions wrap="<h2>Directions</h2>%s"]
[arlo_venue_parking wrap="<h2>Parking</h2>%s"]

[arlo_venue_list_item]

Repeats the markup and shortcodes inside it once for each venue, in name order.

Type: Enclosing. Put your markup and other shortcodes between [arlo_venue_list_item] and [/arlo_venue_list_item].
Use in: the Venues list template.

Structure

[arlo_venue_list_item limit="6"]
  <div class="venue">[arlo_venue_name]</div>
[/arlo_venue_list_item]

Output (example)

Rendered as HTML:

<div class="venue">Harbour Centre</div>
<div class="venue">Northside Studio</div>
…
<script type="application/ld+json">{"@type":"ItemList", …}</script>

Usage

  • Venues are listed alphabetically by name, a page at a time. Without limit, the page size is the WordPress Posts per page setting.
  • Use the same limit on [arlo_venue_list_pagination] so the page links match the list.
  • Structured data (an ItemList script) for the venues on the page is added after the last item automatically.

Attributes

AttributeType / valuesDefaultDescription
limit Integer The WordPress Posts per page setting Number of venues on each page.

Also accepts the universal attributes.

[arlo_venue_list_pagination]

Outputs the page links for the venue list, using WordPress paging.

Use in: the Venues list template, after [arlo_venue_list_item].

Structure

<div class="arlo-pager">[arlo_venue_list_pagination limit="6"]</div>

Output (example)

Rendered as HTML, on the first of two pages:

<div class="arlo-pager">
  <span aria-current="page" class="page-numbers current">1</span>
  <a class="page-numbers" href="https://example.com/venues/page/2/">2</a>
  <a class="next page-numbers" href="https://example.com/venues/page/2/">Next »</a>
</div>

Usage

  • Set the same limit as on [arlo_venue_list_item]. The page links are worked out from the number of venues and this limit.

Attributes

AttributeType / valuesDefaultDescription
limit Integer The WordPress Posts per page setting Number of venues on each page. Match the value used on [arlo_venue_list_item].

Also accepts the universal attributes.

[arlo_venue_name]

Outputs the name of the venue as plain text.

Use in: the Venues list template (inside [arlo_venue_list_item]), the Venue template, and inside [arlo_event_list_item] and [arlo_upcoming_list_item].

Structure

<h1>[arlo_venue_name]</h1>

Output (example)

Rendered as HTML:

<h1>Harbour Centre</h1>

Attributes

None. Accepts the universal attributes.

Outputs the URL of the venue's page on your site. It is a URL only, not a link.

Use in: the same places as [arlo_venue_name].

[arlo_venue_permalink wrap="<a href='%s'>"][arlo_venue_name]</a>

Rendered as HTML:

<a href="https://example.com/venues/12-harbour-centre/">Harbour Centre</a>
  • Use wrap to build the opening tag of a link, and close it yourself with </a> after the link text. See attribute placeholders.

None. Accepts the universal attributes; wrap is used in the example above.

Outputs the URL of the venue on Arlo's platform. It is a URL only, not a link.

Use in: the same places as [arlo_venue_name].

[arlo_venue_link wrap="<a href='%s' target='_blank'>View on Arlo</a>"]

Rendered as HTML:

<a href="https://example.arlo.co/venues/12" target="_blank">View on Arlo</a>

None. Accepts the universal attributes; wrap is used in the example above.

[arlo_venue_map]

Outputs a Google map of the venue: an interactive embedded map by default, or a static image.

Use in: the same places as [arlo_venue_name].

Structure

[arlo_venue_map height="300" width="600" zoom="16" type="dynamic" placeholder="images/no-map.jpg"]

Output (example)

Rendered as HTML:

<iframe src="https://www.google.com/maps/embed/v1/place?q=1%20Quay%20Street,Auckland,1010,New%20Zealand&zoom=16&key=…"
        height="300" width="600" frameborder="0" style="border:0"
        title="Map of Harbour Centre" aria-label="Map of Harbour Centre" allowfullscreen></iframe>

Usage

Add a Google Maps API key first

Without a key in GoogleMaps API Key in the General settings, nothing is output, or only the placeholder image if you set one. See the settings.

  • The key needs the Google Maps Embed API enabled for the default map, and the Maps Static API for type="static".
  • The map is shown only for a venue that has map coordinates in Arlo. Otherwise nothing is output, or the placeholder image if you set one.

Attributes

AttributeType / valuesDefaultDescription
height Integer (pixels) 400 Height of the map.
width Integer (pixels) 400 Width of the map.
zoom Integer 16 Google Maps zoom level. A higher number is closer.
type Option: dynamicstatic dynamic dynamic outputs an interactive embedded map; static outputs a map image.
placeholder Path to an image, relative to the plugin folder None Image shown instead of the map when there is no API key or the venue has no coordinates. Since 5.1.0.

Also accepts the universal attributes.

Examples

A static map image:

[arlo_venue_map type="static" width="600" height="300" zoom="14"]
<img src="https://maps.googleapis.com/maps/api/staticmap?markers=color:green%7C-36.800000,174.700000&size=600x300&zoom=14&key=…"
     height="300" width="600" alt="Map of Harbour Centre" />

With a placeholder image, when there is no API key or no coordinates:

[arlo_venue_map placeholder="images/no-map.jpg"]
<img class='arlo-map-placeholder' src='https://example.com/wp-content/plugins/…/images/no-map.jpg' alt='Harbour Centre' />

[arlo_venue_address]

Outputs the address of the venue, as a list or as plain text, optionally wrapped in a link.

Use in: the same places as [arlo_venue_name].

Structure

[arlo_venue_address layout="list" items="line1,line2,line3,line4,suburb,city,state,post_code,country" link="map" wrap="<div class='address'>%s</div>"]

Output (example)

Rendered as HTML:

<div class="address">
  <a href="https://www.google.com/maps/search/?api=1&query=1%20Quay%20Street,Auckland,1010,New%20Zealand" target="_blank">
    <ul class="arlo-address-list">
      <li>1 Quay Street</li>
      <li>Auckland</li>
      <li>Auckland</li>
      <li>1010</li>
      <li>New Zealand</li>
    </ul>
  </a>
</div>

Usage

  • Fields the venue has no value for are left out. Use wrap so nothing is left behind when the whole address is empty.
  • items chooses which fields appear. The order is always the one shown above, whatever order you list them in.
  • In the plain text layout, suburb, city, state and post_code are combined on one line (for example Auckland, Auckland 1010), placed after the address lines and before the country.
  • locale is a shortcut for suburb,city,state,post_code, but only when it is the first value in items, and it then replaces the whole list. items="locale" works; items="line1,locale,country" does not show the locale line. List the four fields instead.

Attributes

AttributeType / valuesDefaultDescription
layout Option: liststring list list outputs a <ul class="arlo-address-list"> with one <li> per field; any other value outputs plain text, one line per field separated by <br>.
items Comma-separated list of: line1line2line3line4suburbcitystatepost_codecountrylocale (locale only as the first value) All of the fields, from line1 to country The address fields to show.
link Option: permalinkviewurimap or a URL None Wraps the address in a link that opens in a new tab: to the venue page on your site (permalink), to the venue in Arlo (viewuri), to the address in Google Maps (map), or to your own URL.

Also accepts the universal attributes.

Examples

Plain text, one line per field, with the suburb, city, state and post code on one line:

[arlo_venue_address layout="string" items="line1,line2,suburb,city,state,post_code,country"]
1 Quay Street<br> Auckland, Auckland 1010 <br> New Zealand

One field per call, so you can place your own markup around each line:

[arlo_venue_address layout="string" items="line1" wrap="%s<br>"]
[arlo_venue_address layout="string" items="locale" wrap="%s<br>"]
[arlo_venue_address layout="string" items="country" wrap="%s"]
1 Quay Street<br>
Auckland, Auckland 1010 <br>
New Zealand

[arlo_venue_direction]

Outputs the URL of Google Maps directions to the venue. It is a URL only, so use wrap to make a link or button.

Use in: the same places as [arlo_venue_name]. Since 5.1.0.

Structure

[arlo_venue_direction wrap="<a target='_blank' class='button' href='%s'>Get directions</a>"]

Output (example)

Rendered as HTML:

<a target="_blank" class="button" href="https://www.google.com/maps/dir//1%20Quay%20Street,Auckland,1010,New%20Zealand/@-36.800000,174.700000">Get directions</a>

Usage

Not the same as [arlo_venue_directions]

[arlo_venue_direction] (singular) outputs a Google Maps URL. [arlo_venue_directions] (plural) outputs the written directions entered for the venue in Arlo.

  • A URL is output only for a venue that has map coordinates in Arlo. Use wrap so no empty link is left behind.

Attributes

None. Accepts the universal attributes; wrap is used in the example above.

[arlo_venue_directions]

Outputs the written directions for the venue, as entered in Arlo.

Use in: the same places as [arlo_venue_name].

Structure

[arlo_venue_directions wrap="<h2>Directions</h2>%s"]

Output (example)

Rendered as HTML:

<h2>Directions</h2><p>Use the north entrance and ask at reception.</p>

Usage

  • The text may contain basic HTML, as in a WordPress post.
  • Not every venue has directions, so use wrap to keep the heading from showing on its own.

Attributes

None. Accepts the universal attributes; wrap is used in the example above.

[arlo_venue_parking]

Outputs the parking information for the venue, as entered in Arlo.

Use in: the same places as [arlo_venue_name].

Structure

[arlo_venue_parking wrap="<h2>Parking</h2>%s"]

Output (example)

Rendered as HTML:

<h2>Parking</h2><p>Paid parking is available under the building.</p>

Usage

  • The text may contain basic HTML, as in a WordPress post.
  • Not every venue has parking information, so use wrap to keep the heading from showing on its own.

Attributes

None. Accepts the universal attributes; wrap is used in the example above.

[arlo_venue_locationname]

Outputs the location name of the venue as plain text.

Use in: the same places as [arlo_venue_name].

Structure

[arlo_venue_locationname label="Location: " wrap="<p>%s</p>"]

Output (example)

Rendered as HTML:

<p><label>Location: </label> Harbour Campus</p>

Usage

  • Not every venue has a location name, so use wrap and label, which output only when there is a value.

Attributes

None. Accepts the universal attributes; wrap and label are used in the example above.

Outputs the URL of the Upcoming events or Schedule page, filtered to the venue. It is a URL only, not a link.

Use in: the same places as [arlo_venue_name].

[arlo_venue_events_link link_page="upcoming" wrap="<a href='%s'>View upcoming events</a>"]

Rendered as HTML:

<a href="https://example.com/upcoming/venue-12-Harbour%20Centre/">View upcoming events</a>
  • The page linked to is the one assigned to Upcoming events or Schedule in the plugin's page settings. If that page is not set, nothing is output, so use wrap. This means dropping the Upcoming events or Schedule page removes the link.
AttributeType / valuesDefaultDescription
link_page Option: upcomingschedule upcoming The page to link to, filtered to this venue.

Also accepts the universal attributes.

[arlo_venue_rich_snippet]

Outputs structured data (JSON-LD) describing the venue as a place, for search engines.

Use in: the Venue template and the other places listed for [arlo_venue_name].

Structure

[arlo_venue_rich_snippet link="permalink"]

Output (example)

Rendered as HTML. Nothing is shown on the page:

<script type="application/ld+json">
{"@type":"Place","name":"Harbour Centre","url":"https://example.com/venues/12-harbour-centre/",
 "address":{"@type":["PostalAddress"],"streetAddress":"1 Quay Street","addressLocality":"Auckland","postalCode":"1010","addressCountry":"New Zealand"},
 "location":{"geo":{"@type":"GeoCoordinates","latitude":"-36.8","longitude":"174.7"}}}
</script>

Usage

  • Put it once in the template, outside any visible markup. Only the details the venue has are included.

Attributes

AttributeType / valuesDefaultDescription
link Option: permalinkviewuri permalink The URL given for the venue: its page on your site (permalink), or the venue in Arlo (viewuri).

Also accepts the universal attributes.