VS Event List

About

This is a lightweight plugin to create a customized event list.

Add the shortcode on a page or use the widget to display your events.

You can personalize your event list via the settings page or by adding attributes to the shortcode or the widget.

How to use

After installation go to menu item “Events” and start adding your events.

Create a page and add shortcode:

• [vsel] to display upcoming events (with today)
• [vsel-future-events] to display future events (without today)
• [vsel-current-events] to display current events (today)
• [vsel-past-events] to display past events (before today)
• [vsel-all-events] to display all events

Or go to Appearance > Widgets and use the widget to display your events.

Settings page

You can personalize your event list via the settings page. This page is located at Settings > VS Event List.

Several settings can be overridden when using the relevant (shortcode) attributes below.

This can be useful when having multiple event lists on your website.

Shortcode attributes

You can also personalize your event list by adding attributes to the shortcodes mentioned above. Attributes will override the settings page.

• Add custom CSS class to event list: class="your-class-here"
• Change the number of events per page: posts_per_page="5"
• Pass over one or multiple events: offset="1"
• Change date format: date_format="j F Y"
• Display events from a certain category: event_cat="your-category-slug"
• Display events from multiple categories: event_cat="your-category-slug-1, your-category-slug-2"
• Reverse order of upcoming, future and current events list: order="DESC"
• Reverse order of past and all events list: order="ASC"
• Change no events are found text: no_events_text="your text here"
• Disable event title link: title_link="false"
• Disable featured image link: featured_image_link="false"
• Disable featured image caption: featured_image_caption="false"
• Disable featured image: featured_image="false"
• Disable read more link: read_more="false"
• Disable pagination: pagination="false"
• Display all event info: event_info="all"
• Display summary: event_info="summary"

About the offset attribute: pagination is being disabled when using offset.

Examples:

• One attribute: [vsel posts_per_page="5"]
• Multiple attributes: [vsel posts_per_page="5" event_cat="your-category-slug" event_info="summary"]

Widget attributes

The widget supports the same attributes. Don’t add the main shortcode tag or the brackets.

Examples:

• One attribute: posts_per_page="5"
• Multiple attributes: posts_per_page="5" event_cat="your-category-slug" event_info="summary"

Featured image

The featured image will be used as primary image for every event.

By default the “post thumbnail” is being used as source for the featured image. The size of the post thumbnail may vary by theme.

WordPress creates duplicate images in different sizes upon upload. These sizes can be set via Settings > Media. In case the post thumbnail doesn’t look nice you can choose a different size via the settings page.

Besides this you can also change the maximum width of the featured image.

The featured image on the single event page is handled by your theme.

Default support

Plugin supports the single event page, the event category page, the post type (event) archive page and the search results page. It hooks into the theme template file that is being used by these pages.

Support for the single event page is needed. Support for the other pages is added to make VS Event List compatible with page builder plugins. Events on default WP pages are not ordered by event date.

Plugin activates the post attributes box in the editor. In the post attributes box you can set a custom order for events with the same date. Custom order is not needed when event has start time and end time.

Plugin supports the menu page. Support is added to make VS Event List compatible with page builder plugins.

Advanced Custom Fields

You can add extra fields to the event details by using the Advanced Custom Fields plugin. The most commonly used fields are supported.

Create a field group for post type “event” and add fields to this group. This field group will be added to the editor.

RSS and iCal feed

You can share your upcoming events via a RSS feed.

The default RSS widget will display events from future to upcoming. To reverse this order I recommend using a RSS feed plugin.

You can share your upcoming and past events with an external calendar via an iCal feed.

To activate both feeds go to the settings page.

Uninstall

If you uninstall plugin via dashboard all events and settings will be removed from database.

All posts of the (custom) post type “event” will be removed.

You can avoid this via the settings page.

Question?

Please take a look at the FAQ section.

Translation

Not included but plugin supports WordPress language packs.

More translations are very welcome!

The translation folder inside this plugin is redundant but kept for reference.

Credits

Without the WordPress codex and help from the WordPress community I was not able to develop this plugin, so: thank you!

Enjoy!