Custom fields shortcode reference

Requirements: EventKoi Pro. Custom fields are not available in EventKoi Lite.

Overview

Custom fields let you add your own data to events, such as a speaker name, a sponsor logo, or a record picker, under Settings > Custom fields. Once a field has values, you can pull it into a page with the [eventkoi] shortcode, using the field’s own key.

[eventkoi id="10" data="event_field_speaker_name"]

Syntax

• event_field_<key> pulls a single custom field’s value.
• event_fieldgroup_<key> pulls every field in a field group at once, in that group’s configured order.

To get the correct entry, head to Settings > Custom data > Custom fields and copy the id of the custom field you want.

How each field type outputs

• text, textarea, dropdown, radio, checkbox: plain escaped text.
• url: if this is the only key in your data list, it shows as plain text with no link. If you request it alongside other keys, or if you add as_link=1, it shows as a clickable link instead.
• tel: follows the same rule as url. Alone, plain text. Combined with other keys, or with as_link=1, a clickable tel: link. If what you typed is not a plain dialable number, for example a vanity line like “1-800-FLOWERS”, it always shows as plain text, unlinked, regardless of as_link.
• richtext: always keeps its HTML formatting, such as lists, headings, and paragraphs, no matter how you request it.
• grouped dropdown: see below.

Grouped dropdown fields and subfields

A Grouped dropdown field lets an event author pick one option from a list, where each option brings along a group of related details. For example, picking a venue and having its address, city, and post code appear automatically. By default, event_field_<key> outputs every filled in detail for the selected option, one per line.

To pull just one of those details, add the overall group dropdown field id, followed by a dot followed by the individual field id:

[eventkoi id="10" data="event_field_venue.address"]

Adding a label

Two ways to show the field’s name alongside its value. Both give the same result.

[eventkoi id="10" data="event_field_speaker_name_with_name"]
[eventkoi id="10" data="event_field_speaker_name" with_name=1]

For a grouped dropdown subfield, the label shown is the column’s own label, for example “Address”, rather than the field’s overall name, if one is set for that column.

as_link

as_link=1 only changes anything for url and tel type fields. It forces them to always show as a clickable link, even when the field is the only key requested. It has no effect on any other field type.

[eventkoi id="10" data="event_field_website" as_link=1]

Bulk keys

• event_custom_fields pulls every filled in custom field the event has, in the order configured under Settings > Custom fields, or the event’s own manually arranged layout, if one was set.
• event_custom_fields_with_name does the same, with each field’s label shown.

Empty fields are skipped automatically. Fields belonging to a group are wrapped together so a theme can style the whole group as one unit.

Examples

1. Basic field: [eventkoi id="10" data="event_field_speaker_name"]
2. Field with label: [eventkoi id="10" data="event_field_speaker_name_with_name"]
3. Grouped dropdown subfield: [eventkoi id="10" data="event_field_venue.address"]
4. URL field as a clickable link: [eventkoi id="10" data="event_field_website" as_link=1]
5. Whole field group: [eventkoi id="10" data="event_fieldgroup_sponsor_info"]
6. All filled in fields with labels: [eventkoi id="10" data="event_custom_fields_with_name"]
7. Combine built-in keys with custom field keys: [eventkoi data="event_title,event_field_speaker_name"].

More shortcodes

For the full list of EventKoi shortcodes, see EventKoi Shortcodes Reference Guide: Start Here.