Home

The UCF-Events-Plugin provides a standard set of tools for fetching and displaying events from Events at UCF on a WordPress site. It comes with a widget and shortcode for displaying events, and currently a single default layout. Additional layouts can be added via code in the functions.php file or could be bundled in an additional plugin for distribution.

Installation Requirements

Currently, the plugin does not have any plugin or javascript dependencies. Any dependencies for layouts should either be handled in the theme or bundled together with (or included by) a separate plugin.

To install the plugin:

1. Upload the (unzipped) [plugin project] to the /wp-content/plugins/ directory.
2. Activate the plugin through the "Plugins" screen in the admin screen of your site.
3. Configure the plugin in the "UCF Events Settings" page found at Settings > UCF Events in the admin screen.

Configuration Options

UCF Events JSON Feed URL: The default URL to use when fetching events from Events at UCF.

Include Default CSS: When checked, the ucf-events.min.css file included with the plugin will be included on all pages.

Transient Data Expiration: When events are fetched from the events feed, they are stored as transients in WordPress. This is to prevent the need to fetch the events feed every time a page loads. This setting sets the expiration of the transient in hours. Defaults to 3 hours.

Extending the Plugin

There is currently one provided layout that comes with the plugin, labeled "Classic Layout". This layout is used by default when using the shortcode or widget. This layout should closely match the former layout for events on www.ucf.edu. For more information on adding layouts, see the layout development page.