Getting Started

The Eventim Client Portal for WordPress (CP4WP) plug-in is currently in beta and will benefit greatly from all instances where you find a bug, potential improvement, or feature request.

If you have not yet received the plug-in, contact creative@eventim.com for the latest version.

The plugin was built by Eventim to display your events for users on mobile and desktop. CP4WP uses Material Design by Google as a framework for the layout. You will see the option for Outlined or Elevated Material Card designs. The Outlined design uses a thin border and no drop shadow. The Elevated design uses drop shadows and has no outline. 

Contact creative@eventim.com to get started with the plugin on your website. You will need access to the Admin of your WordPress website.

Client account on Eventim

Access to API Credentials creation workflow on your Eventim Dashboard.

Event(s) built and active

You can activate the plug-in without events, but we do recommend having at least one event to test the plug-in design and layout for your website.

Plug-in Dependencies / Required Installation 

Advanced Custom Fields Free Plug-in

The CP4WP plug-in requires the Advanced Custom Fields Free plug-in to be installed prior to installing CP4WP. Without installation, you will receive an error message.

The ACF Pro version of the ACF plug-in is also compatible with CP4WP.

After logging into the Admin of your WordPress site, go to Plug-ins > Add New. Search for the ACF plug-in or upload the plug-in using the Upload Plug-in button. 

Once installed, activate Advanced Custom Fields. 

Once both ACF and CP4WP are installed and activated, the CP4WP plug-in will connect to ACF without your intervention.

Installation and Activation

 Installing the CP4WP plug-in will follow the same steps as installing ACF. Go to Plug-in > Add New. This is not a plug-in published to the WordPress plug-in directory, so you will need to upload the plug-in manually using the Upload Plug-in button. 

As mentioned, if the Advanced Custom Fields plug-in is not installed prior, an error message will appear. Easily resolve this error by installing ACF or ACF Pro. 

The CP4WP plug-in will populate the event data fields using the ACF fields present on the Eventim event posts. This data comes directly from your Eventim events.

The CP4WP plug-in will be titled “See Tickets” or “Eventim US Event Listings” on the list of active plug-ins.

Once activated, your sidebar will populate a custom post type titled “See Tickets Events” or “Eventim US Events” and a General Settings page titled “Client Portal”.

Eventim API Credentials

To specify which data the plug-in should access on Eventim and populate on your website, fill in the API credentials on the Client Portal page in the Eventim Credentials section.

You are required to create and use a set of credentials for your website. You will need:

• API Key
• API Secret
• Client ID

To access your Eventim Credentials, go to your client dashboard in the Eventim Client Dashboard. Under Market on the left side navigation, find API Credentials option. From this page you will create and copy your Client ID, API Key, and API Secret into the Client Portal settings.

When creating API Credentials for the WP Plugin, "Events" is the only item needed to be selected. 

The API Secret will never be shown again, so keep the credentials stored in a safe place. 

If you have multiple client accounts populating to your website, you will need to repeat this process on each client account that you want to populate on your website. 

After adding your credentials to the Client Portal Settings page, select Save Settings and then Run Event Feed. These buttons are found on the top and bottom of the Client Portal Settings page. Imported events will now populate in the custom post type: “See Tickets Events” or “Eventim US Events”.

Scheduled Import

Enable the scheduled import of event data at the interval you would like the event data to be retrieved from your Eventim client account. We recommend the 1-minute interval to keep things the most current.

Fields to exclude from updating

By enabling the exclusion of fields from updating, the plug-in will import the event as-is when published on Eventim. After the initial import, any fields excluded from updating will not be updated on your website. All others will continue to update at the interval selected for the Scheduled Interval. This feature is often used for ticket status which imports the status of Buy Tickets, Not Available, Coming Soon, or Box Office Only.

Set a default image for events

In the case that an event image has not been added in the Eventim event build, choose a custom default image as a fallback for event listings with no images. Typically, this is your logo. The default image will appear on all events that do not have an event image imported from the Eventim event.

Additional Notes:

The event images imported from Eventim are displayed as a square. Creating square images for your default image would be the best practice. Using square images in your event builds is encouraged but is not required. 

Custom CSS can be used to override the squares to display the default aspect ratio of the event image. For example, if you prefer to use a portrait layout for images, you can add Custom CSS to your theme to apply a height of auto to the images. You may need to use !important to override. 

Social sharing icons

Included in the event cards are icons for sharing an event directly to Facebook and X. In the Client Portal, select whether the icons display as icons only or in a filled circle. Use the color picker to set a filled color circle. 

Custom Labels

Customize how the labels appear for the supporting talent, door time, and show time in the event card. If the labels are not necessary for the site, they can be hidden with a checkbox.

Common use cases include labeling supporting talent using a custom label of “with” or door time to read “Doors:” on the event card.

All button statuses read

The plugin allows you to control what all button statuses read for all events imported onto your site. This will override all new, previous, and future events imported into your site. This also includes events in the event slider, “Just announced” section, filtered events, and search results. If you set this to say “Get Tickets” all ticket buttons site-wide will read “Get Tickets” regardless of their status in the Eventim event. 

Show repeating events in admin

For multi-day events, you can enable the plug-in to create duplicate posts for all days of the event. All duplicate events will share the same Eventim ticket link for the multi-day event. This is a good option if you want to show the same event on the calendar for all days that the event is taking place, instead of a single event card with a date range listed.

Link event title and image

Select whether all events link directly to the Eventim event page or if they link to single event pages on your website. There are fields available on the Eventim Events posts pages in the backend of your site that will be displayed on the single WordPress event page. Single event pages will automatically include all event card data. Some but not all Blocks can be added to the Editor to build a more detailed events page found on your website. 

Order of event card elements

Drag and drop to arrange elements on your event cards. To rearrange, hover over the three bars on the field you’d like to move and click to select it. Drag the box to the location desired and release the cursor to drop it. 

Ticket Status

Your ticket status will be the text that is displayed inside the event card button. The default statuses are:

• Buy Tickets (Tickets available for sale online)
• Sold Out (No tickets remaining for all ticket types)
• Not Available (General catchall when tickets aren’t available)
• Box Office Only (Tickets are only available in the Box Office)
• Hidden Only (Only hidden ticket types are available)
• Coming Soon (Tickets are not on-sale yet, either using an event on-sale timer or if all ticket timers are set.)

Ticket Status Logic

The ticket button displays button text based on the following rules, in the following order:

If the off-sale time is met, the button will display Event Passed.

If you are using the All Ticket Status Read button option under General Settings, the button will always display the defined text. 

If any user defined criteria is met for displaying event as past event, the button will display Event Passed.

If none of the above conditions are met, the button will display the actual ticket status text from the event build on Eventim.

Customizing Ticket Statuses in ACF 

The plugin uses a JSON file to acquire and display the Advanced Custom Fields labels for ticket button status. The plugin gets these ticket (event) status assignments from your Eventim Client Dashboard. However, ACF allows customization of these labels on your site. For example, you can update all Not Available statuses to read Sold Out. This does not affect the messaging on the Eventim event page.

To adjust a ticket button status:

• Navigate to ACF in the left sidebar of WordPress.
• Click on See Tickets Event Fields, or Eventim Event Fields, to open the fields inside the group.
• Scroll down to the Ticket Status field.
• Click Edit to open.
• On the panel that slides down, scroll to Choices.
• Save the changes using the Save button in the top right corner of the page.

Adjusted Choices

When updating the CP4WP plugin version to a newer version, the ACF fields will need to be saved again to reset the customizations. This is due to how the plugin stores data in the database.

To save customizations, it is very simple. Retyping the Ticket Status text is not necessary. The ACF will only need a quick resave of the fields to reset the customized labels.

• Navigate to ACF on the left sidebar
• Go to the Event Fields
• Click Edit to open
• Save the page. No further action is necessary. 

This will apply the customized ticket button status labels site wide. The customized labels will now be used by the site instead of the Dashboard status of the event.

Eventim US Events Post Type

Events being imported from the Client Portal for WordPress plugin will be populated in the See Tickets / Eventim US Events posts. Inside each post type you will have the ability to change the button status (from Get Tickets to Sold Out, for example) or update any of the event information.

To make sure your event details options stay customized and not overwritten on each import according to the Eventim-build event, you will need to go to the Client Portal page and exclude fields from updating. This exclusion customization will affect all events and therefore will not update once the initial import process has taken place.

Single Post Page

Selecting Eventim event page on the Client Portal page will send users to the White Label when they press a ticket button on your website.

To edit the Single Event Post Page for a specific event, first find the event in the Events posts. Click the event name to edit the event post page. 

After making changes, click Update in the top right corner of the post to save the changes. Visit the single event post page front end to review the layout. By default, the new content appears directly below the event card.

Shortcodes

First, configure all event listings, calendar settings, and customizations on the Client Portal Settings page.

To display events with a shortcode on a page of the site, copy the shortcode and paste it into a page editor. This works with the WordPress Block Editor. If using Block Editor, add the shortcode using the Shortcode Block. 

For Classic Editor:

[your_shortcode]

For HTML/PHP page templates, you can use:

<?php echo do_shortcode( "[your_shortcode]" ); ?> 

Event Calendar

This shortcode is a calendar of events from your Eventim account. Copy the shortcode text from the Client Portal page and paste the copied shortcode into the editor of the page to display a calendar on the front end of the website.

Customize whether Sunday or Monday is a choice for the start of the week.

You can hide months that have no events in them.

If you have the same event with an early and late show, there is an option to hide the second image to remove cluttered visuals.

You can opt to show only a few months ahead instead of a full year or show additional months longer than a year as needed. 

On mobile, the calendar is replaced by a single column event list view for ease of use.

Event Slider 

The event slider shortcode will always show the next 1-10 upcoming events in chronological order. 

Choose how many events you’d like to display (up to 10) and if you would like the slider to automatically slide. 

Select with or without text, and with arrows on the slider for navigating between the event or with circles on the bottom of the slide. 

Event List Grid View

This shortcode will show the chosen number of upcoming events from your Eventim account, in chronological order. The layout will be a grid with the number of column options from 2-4. You will select the number of columns, the number of visible events, and whether you would like pagination or a “Load More” button to add events to the page.

Event Search 

This is a dual shortcode to use for searching events on a website and placing the results in a specific area. Set the parameters, and the Shortcode will update accordingly. Parameters include genre, event title, location, supporting talent, and headliners. After setting up the search parameters, copy the search shortcode and place it on a page, in a widget, in a pattern, or in a template file.

If adding the search shortcode to a single page, such as the homepage, don’t forget to add the search results shortcode along with it. Search results will only appear if the results shortcode is included on the page. 

If adding the search shortcode to a header, footer, widget, pattern, or php theme partial, the Site Theme will need to be modified. Use the do_shortcode method to include the results shortcode in the theme files. This allows the results to appear when the site is searched from any page.

Add the search shortcode to the header or footer file. Modify the page templates to place the search results shortcode.

Use php to call the search:

do_shortcode(‘[eventsearch fields=’event_title’])

Just Announced Events

This shortcode will show 1-10 of the most recently announced events from your Eventim account data. Choose the number of events shown in the Just Announced settings section.

For Just Announced to properly display in the order of announced date and time, the events on Eventim must have a Public Announce Date/Time. This is added either in your event build or in the Event Settings on your Eventim Dashboard and will populate as the Publish Date field on your website. 

If you have 5 events chosen to display on the Just Announced settings section, and only 2 with a Public Announce Date/Time on Eventim, the plug-in logic considers an empty value for publish date to be the most recent and will list these dates first in your Just Announced section. 

Event Filtered View: Categories and Tags

This shortcode will show events with a specific category or specific tag. This can also be set up to display multiple categories or tags. Copy the shortcode and paste into the page you want the list view on. 

Category Filter

Categories for the Client Portal settings page will need to be manually created inside of WordPress. 

Tag Filter

Tags, however, are imported with your Eventim events. They are the Search Tags from your event build. Tags are added and removed from the Eventim event creation process. They can be selected and deselected on the Client Portal page to create a filtered event list/grid view. You can add more than one filtered shortcode around the site with different tags in each instance.

Color Selections

In the Color Selection area, there are 5 boxes with color pickers. This is where colors can be set for elements of your event cards. You can override this with your theme CSS.

• Button background color: This is the ticket button background color.
• Button text color: This is the color of the text on the button.
• Button text hover color: This is the color of button text when the cursor is hovering on the button.
• Event listing background color: This is the background color of the event card.
• Text color: This is the text color on the card. 

Choose your colors and then set the colors by using the Save Settings and Run Event Feed buttons. Use the reset button if you need to start over and select new colors.

Custom CSS

Some versions include a text box for custom CSS. Write new styles using the classes in the HTML to further customize the look of your event cards, calendar, search, and event slider. Some versions do not include the custom CSS box. Adding your styles to your theme stylesheet is always the best route for making modifications to the event layout, colors, or fonts. 

Limitations

The Eventim US Events plug-in does not work very well with common page builders such as Elementor.