Skip to content
Jo Dickson edited this page Oct 4, 2021 · 8 revisions

The UCF-News-Plugin provides a standard set of tools for fetching and displaying news stories from UCF Today on a WordPress site. It comes with a widget and shortcode for displaying stories, and several layout options for displaying them. Additional layouts can be added via code in the functions.php file or could be bundled in an additional plugin for distribution; see the layout development page for more information on developing layouts.

Installation Requirements

Note: as of v3.0.0, all layouts provided by this plugin require the Athena Framework v1.1.0+ in order to display as intended. We recommend using this plugin with the UCF WordPress Theme v0.7.2+, UCF's Colleges Theme v1.1.2+, or another theme that enqueues Athena's styles. This plugin will not enqueue the Athena Framework.

If you are not/cannot use a theme that includes Athena, you can define your own layout(s) and styles in your theme as needed.

Currently, the plugin does not have any plugin or javascript dependencies.

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 News Settings" page found at Settings > UCF News in the admin screen.

Configuration Options

UCF News Feed URL: The base URL of the UCF News JSON feed.

Fallback Image: The classic layout includes an image next to each story. If an image is not available from the feed, this fallback image will be used. If no image is provided, the image tag will not be output, which could potentially result in some awkward layouts.

Overview

Home

Widget

Shortcode

For Developers

Custom Layouts

Clone this wiki locally