Settings
You configure the plugin under Arlo > Settings in the WordPress admin. The settings are split across tabs, and a single Save Changes button saves everything on the Theme, General, Pages, Regions, Custom CSS and Misc tabs.
| Tab | Use it to |
|---|---|
| Theme | Choose the look of your Arlo pages. |
| General | Connect your Arlo platform and set how prices and empty lists display. |
| Pages | Assign WordPress pages to each Arlo page type, edit templates, and add custom shortcodes. |
| Regions | Define the regions of a multi-region platform. |
| Custom CSS | Move legacy custom CSS to WordPress Additional CSS. |
| Misc | Synchronization, logging, and clean-up options. |
| System requirements, Changelog, Support | Check your server, read what is new, and find help. |
First-time setup: on a new install the plugin does not contact Arlo until you save your platform name on the General tab or choose Test with demo data. It also creates draft host pages for you. Publish those pages, then check they are assigned on the Pages tab.
Theme
The Theme tab lists the available control themes. A theme supplies the stylesheet and the default templates for every Arlo page, so applying one restyles all your Arlo pages at once.
- Apply switches to the theme. The plugin remembers the template edits you make under each theme, so switching back to a theme you have used brings your edits back.
- Apply & Reset (shown as Reset on the current theme) also restores the theme's original templates, discarding your edits to them.
- Preview opens a demo of the theme, and Current marks the theme in use.
- Themes labelled For designers inherit some of your website's own styles. They are the most flexible, but a web designer may need to fix styling clashes.
- The Custom theme has no reset, because it has no original templates to return to.
To adjust a theme's styling, add rules in WordPress Additional CSS (see Custom CSS).
General
Arlo platform URL
The name of your Arlo platform, which is the first part of your Arlo web address.
https://YOUR_PLATFORM_NAME.arlo.co/
Enter just the name. The plugin checks it when you save, accepting letters, numbers and hyphens, and checking the platform can be reached. An invalid name is not saved.
While no platform is saved, Test with demo data connects the plugin to a sample Arlo platform so you can try it out. Saving a platform starts the first import. See First-time setup.
Status
Shows whether the plugin is synchronizing with your platform, and when it last did. It is also shown as a badge on every Arlo screen.
| Status | Meaning |
|---|---|
| Connected | Synchronization is working. Synchronize now starts an import straight away. |
| Connected, Manual sync only | Automatic synchronization is switched off (see Automatic synchronization enabled). Re-enable auto-sync turns it back on. |
| Connecting | Recent attempts to reach the platform failed and the plugin is still trying. Retry tries again now, and View logs shows the failures. If it keeps failing, see Fixing blocked callbacks. |
| Disconnected | Repeated failures made the plugin stop synchronizing, and the reason is shown. Fix the cause, then choose Reconnect. Blocked callbacks are the most common cause: see Fixing blocked callbacks. |
| Setup required | The site does not meet the system requirements, so importing is switched off. |
Deployment
Production or Non-production. Non-production sites, such as staging copies, synchronize less often.
Price shown
How prices are labelled wherever the plugin shows them.
- Exclude GST. Adds an "excl. GST" label after the price. This is the default.
- Include GST. Adds an "incl. GST" label after the price.
The "GST" wording comes from your platform's region, so a UK platform says "VAT". Contact Arlo support to change it, and note that it also affects other areas of your platform. This setting does not change the currency. With regions mapped, a page shows one currency, from the visitor's region.
"Free" text
The text shown instead of a price when an event is free, for example "No charge". The default is Free.
"No events to show" text
The message shown when a catalogue, schedule, search or upcoming list has no results. Your template outputs it with [arlo_no_event_text]. The default is No events to show.
No event on a template text
The message shown on an event page when that event has nothing scheduled. Your template outputs it with [arlo_event_template_register_interest]. The default asks visitors whether they are interested in attending, and a "Register your interest" link follows it.
GoogleMaps API Key
Required to show maps with [arlo_venue_map]. Without a key the map is not shown. Google's instructions explain how to create one.
Enable the Maps Embed API for your project. Also enable the Maps Static API if any template uses type="static".
Import callback host
When a synchronization runs, the Arlo platform calls back to your site to deliver the data. By default it calls your site's own address, so this setting is usually blank, in development and in production.
Set it only when your network needs the internet-facing domain name to be given explicitly, for example behind a firewall, gateway or load balancer, or when a local development site is exposed through a tunnel. Your network or IT administrator can tell you if it is required. The setting works the same way in development and production. If imports fail while this is blank, a firewall or security plugin blocking the callback is the usual cause: see Fixing blocked callbacks.
Enter a host name with an optional port, such as example.org:9541, or a full http or https address. The plugin uses only the host and port from this setting: it replaces your site's host and port in the callback address and keeps the rest, including the scheme, as your site generates it. A scheme you enter (or the https the plugin assumes when you leave it out) is checked but not used, so entering https:// does not make the callback use HTTPS. For a local development site, see developing on a local machine.
Tax exempt tag
A tag you apply to events in Arlo to make them display as tax free. See set an event as tax-free in the Arlo help centre.
Filter terminology
Rename or exclude options in the Delivery filter dropdown. Choose Rename to give an option new wording, or Exclude to hide it.
Pages
The Pages tab has one sub-tab for each type of Arlo page. For each you choose the WordPress page that shows it, edit its template, and optionally limit what it lists.
Host pages
An Arlo list page is an ordinary WordPress page that contains one global shortcode. That page is the host page, and its address is the address of that kind of page, such as /events/ for the catalogue. The plugin creates a draft host page for each type when it is installed, so publish them (or pick your own pages), then choose the page in the Host page dropdown. To change an address, change the page's slug in WordPress and then choose Save Changes here. Changing only the page title does not change its existing slug. See Pages and routing.
| Sub-tab | Shortcode on the host page |
|---|---|
| Catalogue | [arlo_event_template_list] |
| Schedule | [arlo_schedule] |
| Event search list | [arlo_event_template_search_list] |
| Upcoming event list | [arlo_upcoming_list] |
| Online activity list | [arlo_onlineactivites_list] |
| Presenter list | [arlo_presenter_list] |
| Venue list | [arlo_venue_list] |
| Event, Presenter, Venue | None. There is one single page for every event template (course), presenter and venue, so there is no one page to map. Each takes its base address from its parent, the Catalogue, Presenters or Venues host page, such as /events/123-course-name/, and you only edit its template. |
- The dropdown marks pages that are not published (draft, pending, private, scheduled), and warns if the same page is chosen for two page types.
- When you choose a page, the plugin checks that its body contains the matching global shortcode and shows the result beside the dropdown. A wrong mapping can break filtering and paging, so fix any warning. See Checking a page is mapped correctly.
- Keep one global shortcode on each host page. Two on the same page cannot both read the filters and page number in its address. See One global shortcode per page.
- If there are no published pages, the tab offers Review pages or Add draft pages to get you started.
- You do not have to map every page type. Set the Host page to (None) for a page you do not use. That does not change whether the WordPress page is published, so unpublish it in WordPress, or remove its global shortcode. Keep Catalogue, Venues and Presenters mapped if you use event, venue or presenter pages. See Pages you do not need.
- The URL / slug row shows the page's address, with links to view, preview or edit it.
Templates
Each sub-tab also holds the page's Template, the HTML and shortcodes that build the page. See Templates for what each page type can contain. Reload original template replaces your edits with the selected theme's version.
Only users who are allowed to add raw HTML (the WordPress unfiltered_html capability) can edit templates. That is administrators on a single site and super administrators on a multisite network, and nobody when DISALLOW_UNFILTERED_HTML is set. Other users see the template read-only.
The Customisation options link opens the global shortcode reference, which lists the attributes you can add to the host page's shortcode.
Page filtered by
Limits a page to part of your catalogue without editing the shortcode. Choose Hide all except to list only the matching items, or Show all except to leave them out, then pick the values to match. The filters available depend on the page.
- Upcoming: category, location, delivery, event tag and template tag.
- Catalogue and Schedule: category, delivery, location and template tag.
- Online activities: category and template tag.
A filter set as an attribute on the page's shortcode takes priority over this setting. See Filtering.
Custom shortcodes
Add your own global shortcodes to show the same kind of list on more than one page, each with its own template and filter. Use the New sub-tab, enter a name, and choose its type: Catalogue, Schedule, Upcoming, Online Activities, Presenters or Venues.
The shortcode is [arlo_ plus your name ]. The name is lower-cased, spaces become underscores, and it is cut to 15 characters. The new sub-tab starts with the default template for its type, and a Delete link removes it. See custom shortcodes.
Regions
If your platform has more than one region, define them here. See Regions for how regions work. Each row has a Region ID and a Region name. Add or remove rows with the plus and minus buttons, and drag rows to reorder them. The first region is the default. If your platform has a single region, you can leave this tab empty. See Using no regions.
- Region IDs are at most 16 characters and are saved in upper case. Use the same IDs as your Arlo platform.
- After changing regions, save the settings and then synchronize so the data is imported for each region.
To let visitors choose a region, add a region selector to your templates: [arlo_template_region_selector] for the catalogue, schedule and upcoming pages, or [arlo_template_search_region_selector] for event search. The Region selector widget does the same in a widget area.
Legacy (4.x) mode handling of Region IDs (5 char max)
Before version 5.2.0 the plugin could store only the first 5 characters of a region code from Arlo, so a region coded Global was stored as Globa. From 5.2.0 region codes of up to 16 characters are stored in full. For most sites this needs no action.
This option, under Advanced on the Regions tab, is off by default and is only for sites where all of these apply:
- You have mapped regions in the Region ID rows above.
- The code Arlo uses for one or more of those regions is longer than 5 characters.
- Your mapping and live URLs rely on the shortened IDs, such as
/events/region-GLOBA/, and you need to keep that behaviour without changing the IDs, which could break existing links.
While it is ticked, synchronization cuts every region code to 5 characters, as before 5.2.0, and always runs in full mode, even if Importer mode is set to Default + Delta. The change applies from the next synchronization, so save the settings and choose Synchronize now. Untick it and synchronize again to return to full-length codes.
- Keep the Region IDs above at 5 characters or fewer while it is ticked. A longer ID, such as
GLOBAL, never matches the shortened code and its events do not appear. - Two regions whose codes share the same first 5 characters, such as
SU_NSWandSU_NSD, cannot be told apart while it is ticked, exactly as before 5.2.0. - The first synchronization after upgrading to 5.2.0, including the one the upgrade can queue, stores full-length codes unless this is already on. If you need it, either tick it straight after upgrading and synchronize again, or set it before upgrading with WP-CLI:
wp option patch insert arlo_settings legacy_region_id_handling 1. Do this immediately before the upgrade, as saving settings on an older version drops the value. - When it is on, Arlo > Logs records a line at the start of each synchronization to confirm it is in effect.
- If you would rather use the full codes, leave this off and set each Region ID to the full code. To keep the old addresses working, add separate URL redirects from the shortened addresses, for example
/events/region-GLOBA/, to the full ones, in your web server or a redirect plugin. The region redirect filter does not help here, as it does not run for addresses that already contain a region.
Region redirects
When a visitor opens a regionalized page without a region in the address, the plugin redirects them to the regional address, such as /events/region-DE/. Developers can cancel or change that redirect, which is important if you publish separate regional addresses and use hreflang. See Customizing region redirects.
Custom CSS
Custom CSS now lives in WordPress's own Additional CSS, under Appearance > Customize > Additional CSS (or Appearance > Editor > Styles > Additional CSS for block themes). On a new install, or a site that never had custom CSS, the tab simply points you there.
If your site has custom CSS from an earlier version, it keeps working unchanged until an administrator migrates it. The Custom CSS tab shows a warning icon while a migration is pending.
- Choose Check migration readiness to see whether the CSS can be moved.
- Tick the confirmation, then choose Migrate now. The CSS is added to Additional CSS and starts applying from there immediately. Because it then loads in a different order, check your live pages.
- Revert the migration moves the CSS back while it can still be found in Additional CSS. Edits you made in Additional CSS in the meantime are lost.
- Discard this CSS permanently deletes the old CSS if you no longer need it.
- WordPress keeps Additional CSS separately for each theme. If you change theme after migrating, the tab offers to copy the CSS to the current theme.
- You need the WordPress
edit_csscapability (a super administrator on multisite). Migration is not possible whenDISALLOW_UNFILTERED_HTMLis set.
Misc
Powered by Arlo link enabled
Shows a small "Powered by Arlo" logo linking to arlo.co. It appears on Arlo pages and widgets whose templates include [arlo_powered_by], which most of the bundled templates do. It is off until an administrator turns it on here or from the one-time notice on the Arlo screen. Your saved templates are not changed.
Keep settings when deleting the plugin (highly recommended)
When ticked, deleting the plugin from WordPress keeps your settings, such as regions, theme and page assignments, so a reinstall picks up where you left off. Untick it to remove all the plugin's settings when it is deleted. It is ticked on new installs. Custom CSS migrated to Additional CSS is part of WordPress and is not removed either way.
Import fragment size (in bytes, max 10 MB)
The largest piece of data requested from Arlo in one step of a synchronization. The default is 524288 (0.5 MB) and the maximum is 10485760 (10 MB). Reduce it only if imports fail on a server with strict memory or time limits.
Wait between import tasks (seconds, max 2 sec)
A pause, from 0 to 2 seconds, between import steps to ease the load on a busy server. The default is 0.
Disable SSL verification for import (not recommended)
Turns off certificate checking when your site contacts arlo.co. Use it only if your server cannot verify Arlo's certificate, since it removes a security protection.
Automatic synchronization enabled
On by default. Untick it to stop scheduled synchronization and update only when you choose Synchronize now. Saving a different platform name switches it back on.
Importer mode
Appears only where the database supports it. Default + Delta (experimental) is an experimental performance enhancement that will be fully enabled in a future version. It has no effect for most customers, so leave it on Default.
Enable connection healthchecks (recommended)
On by default. If the platform cannot be reached repeatedly, the plugin pauses synchronization and shows the Status as Disconnected, rather than retrying forever. Choose Reconnect on the Status row once the problem is fixed.
Log diagnostic level
Default, Debug or Trace. Debug and Trace record more detail about synchronization, which is useful when Arlo support asks for it, but they grow the log faster.
Log retention
How many log rows to keep: 10,000 (the default), 25,000, 100,000 or 250,000. Saving a lower limit removes the oldest rows straight away.
Download log
The Download link saves the synchronization log as a CSV file. You can also browse it under Arlo > Logs.
System requirements, Changelog and Support
- System requirements checks your server against what the plugin needs (PHP 7.4 or later, WordPress 7.0 or later, the memory and execution time limits, and the PHP extensions it uses) and shows what to fix. If a requirement is not met, importing is switched off until it is. The tab also reports whether your server's time zone data is current. That check is informational and does not switch importing off.
- Changelog lists what changed in each version.
- Support links to the Arlo help centre and support.