Introduction

Settings

Settings are exposed through the WordPress admin dashboard, but can also be edited programatically using hooks (see developer docs).

There are two scopes for the settings: 1) General settings that are inherent to the plugin and allow control over some of its features; 2) admira settings that relate to admira configurations or options.

General

Cache

  • cached_apis: If admira Proxy API GET requests should be cached (that have a cache duration). This will store the data of those requests and avoid refetching data from admira.
  • cache_duration: Duration of the admira Proxy Router cache. Defines how long the cached data will be stored. After that, data will be fetched again uppon a request and cached accordingly.

Logs

  • logs_level: Log level determines which and how much data will be logged. Options are:
    • Full: All data will be logged, including sensitive information.
    • Basic: Only essential data will be logged, excluding sensitive information.
    • Disabled: No data will be logged.
  • logs_retention: How long to keep logs data (default is 30 days).
  • statistics_retention: How long to keep statistics data (default is 7 days).

Tickets SEO

  • tickets_seo_title: SEO title to the ticket route.
  • tickets_seo_description: SEO description to the ticket route.
  • tickets_seo_image: SEO image to the ticket route.

Analytics

  • analytics_providers: Analytics providers to be used. You can enable multiple providers at the same time (currently only GTM is supported).

Analytics Provider

Make sure to configure your analytics provider correctly to ensure data is tracked properly.

Maintenance Mode

  • maintenance_mode: Maintenance mode type (default is disabled).

admira

API Token and Channels

When creating the API user on admira, it is best to also create a unique channel to give acces to the internal data and features. Make sure to add the channel to all events you want to provide over the online ticket office through the plugin.

Admira API key

  • api_rest_token_auth: API rest_token_auth. This is the key to access the admira API. It is used to authenticate the plugin with your instance of the admira API.

API key change

If you change the API key, you will need to reconfigure the enabled spaces and events after saving.

Enabled spaces

  • admira_spaces: Limit the admira Spaces to be used for the plugin. Also limits the admira Events available to enable/disable.

Enabled events

  • admira_events: Limit the admira Events to be used for the plugin.

Ticket types order

  • ticket_order: Order of the ticket types. This is used to display the ticket types in the specified order. You can add an existing ticket type by adding a label and its corresponding type uuid. The uuid must match an existing ticket type uuid of your admira configuration or it will have no effect. To change the order you can drag and drop each item you added to the list up or down.

Countries order

  • countries_order: Order of the countries. This is used to display the countries in the specified order. To change the order you can drag and drop each item you added to the list up or down.

Cart

  • max_tickets_per_cart: Maximum number of tickets that can be added to a cart.
  • cart_expiration: Expiration time of a Cart. Determines the duration of which the cart will be available an refreshed, it will be considered expired after this time.

Checkout data

  • checkout_data: Data that is available for the user to fill on the checkout process. Each data field can be enabled/disabled and marked as required or not. The available fields are:
    • email: Email of the user. This field is always required and enabled.
    • address: Address of the user.
    • city: City of the user.
    • countryIsoCode: Iso code of the user's country. This is always required when fiscalNumber is enabled and required.
    • fiscalNumber: The VAT number of the user. If enabled and required, it will force countryIsoCode to be filled.
    • name: Name of the user.
    • phone: Phone number of the user.
    • postalCode: Postal code of the user.
    • nationality: Nationality of the user.

Checkout checks

  • checkout_checkboxes: Checkout checkboxes (to store in externalData). These are additional checkboxes that can be added to the checkout process. Each entry has a name, to be used as the externalData key, and label, which will be displayed to the user. You can also mark a check as required or not. The order of the checkboxes will affect the order in which they are displayed to the user. To change the order you can drag and drop each item you added to the list up or down.

Enabled payment methods

  • payment_methods_order: The order of the payment methods. There are 2 lists for this option:
    • enabled: The payment methods that are enabled and will be displayed to the user. This will also define the order in which the payment methods will be displayed. To change the order you can drag and drop each item you added to the list up or down.
    • disabled: The payment methods that are disabled and will not be displayed to the user.

The plugin will not enable any payment method by itself. In order for each payment method to be enabled and displayed, it must also be configured in the admira API, by adding the payment to the channel that is associated with the API user.

Sessions

  • calendar_fetch_level: The level of detail to fetch for the calendar. Options are:
    • sessions: This will fetch the information of all sessions for the current calendar month before day selection.
    • days: This will only fetch the available days for the current calendar month before day selection. Sessions information will be fetched for each day upon selecting it.
    • none: No information will be fetched beforehand. Only the sessions information will be fetched upon selecting a day. This option will not disable calendar days without sessions.
  • session_auto_select: Whether the plugin should auto-select a session when the user initially lands in the sessions page. This option is only available when calendar_fetch_level is set to sessions. If enabled, the closest session to the current user time will be selected automatically.
  • show_soldout_sessions: Whether to show sold out sessions in the calendar or not. If enabled, sold out sessions will be displayed in the calendar, but they will not be selectable. If disabled, sold out sessions will not be displayed at all.

Other options

  • enable_vouchers: Whether to enable vouchers or not. If enabled, the user will be able to use vouchers on the payment process.
  • disable_top_quantity: Whether to disable the quantity of tickets to be added to the cart in the start of the checkout process. If enabled, the user will be able to add any number of tickets to the cart without selecting a quantity first, while still repecting the max number of tickets per cart.
  • show_availability: Whether to show the availability of tickets in the calendar or not. If enabled, the user will be able to see the number of available tickets for each session in the calendar. This will be automatically enabled if disable_top_quantity is enabled.

Maintenance Mode

By default, maintenance is deactivated so reserved routes like /tickets can be accessed by anyone. It can be set into Developer or Full maintenance modes.

Developer maintenance means anyone logged into the backoffice of WordPress can open these pages and use them. Otherwise, non authenticated users will be redirected to the homepage.

Full maintenance means the pages will be in maintenance for everyone.

Existing carts

In all maintenance modes, users who are in the process of paying for a cart will be able to continue until the checkout process is finished.

Previous
Installation
Next
Carts