Today Utilities

Feature and utility plugin for the UCF Today website.

Description

Features and utilities for the UCF Today WordPress site that are otherwise not suited for inclusion within a theme.

Documentation

Head over to the Today Utilities wiki for detailed information about this plugin, installation instructions, and more.

Changelog

1.5.0

Enhancements:

• Added cache clearing logic for the email builder.

1.4.0

Enhancements:

• Added tags to the taxonomy array for resource links.

1.3.1

Enhancements:

• Added composer file.

1.3.0

Enhancements:

• Defined ACF field groups and fields in PHP.

1.2.0

Enhancements:

• Added a concise RSS feed to support the UCF Mobile App.

1.1.1

Enhancements:

• Added a new REST endpoint, main-site-header-story, for use on the main site homepage's header (via the [ucf-news-feed] shortcode) for displaying a featured story.
• Renamed the "EDU News Feed" options page to "Main Site Options", and added options for setting a featured header story for the main site homepage.
• Added a new wp-cli command, wp today embeds flush, which removes all bad oEmbed metadata associated with posts (failed responses for oEmbeds).
• Upgraded packages

1.1.0

Enhancements:

• Added a new Author taxonomy (tu_author) and Statement post type (ucf_statement).
• Updated admin columns for posts and the Statement post type to better differentiate between the Author taxonomy and the original publishing author ("publisher") of the post.
• Added a new REST endpoint, /ucf-news/v1/statement-archives/, that lists grouped links to vanilla Statement endpoints, filtered by year and author.
• Modified the tu_author field on the default Statements REST endpoint to include additional author information for convenience.

Bug Fixes:

• Fixed ordering of GMUCF "featured stories row" columns.

1.0.12

Enhancements:

• Added a filter for the acf/fields/post_object/query filter hook to modify the orderby/order rules of fetched posts in ACF post select inputs, so that posts are sorted by last modified/published date instead of by title.
• Removed some references to nonexistent 'photoset' post type in the ACF config.

1.0.11

Enhancements:

• Extended the request timeout for oEmbed content fetches
• Updated packages

1.0.10

Enhancements:

• Added primary category and tag to post REST API results

1.0.9

Documentation:

• Updated contributing doc to reflect the switch from slack to teams.

1.0.8

Bug Fixes:

• Fixed undefined index 'paged' notice on main site stories feed.

1.0.7

Bug Fixes:

• Corrected PHP notice dealing with accessing an array index that was not set.

1.0.6

Enhancements:

• Added oEmbed support for Juxtapose embeds.

1.0.5

Bug Fixes:

• Added default posts API parameters to the main-site-stories endpoint.

1.0.4

Bug Fixes:

• Updated the image size used for spotlight images.

1.0.3

Bug Fixes:

• Added missing support for category_slugs and tag_slugs params in REST API results for posts. Necessary for compatiblity with the UCF News plugin.

1.0.2

Bug Fixes:

• Updated tu_add_author_byline_to_post_feed function to use proper parameter.
• Added GMUCF Announcements feed logic and customizer option.

1.0.1

Bug Fixes:

• Updated feed to output image size which is valid.

1.0.0

• Initial release

Upgrade Notice

n/a

Development

Note that compiled, minified css and js files are included within the repo. Changes to these files should be tracked via git (so that users installing the plugin using traditional installation methods will have a working plugin out-of-the-box.)

Enabling debug mode in your wp-config.php file is recommended during development to help catch warnings and bugs.

Requirements

• node
• gulp-cli

Instructions

1. Clone the Today-Utilities repo into your local development environment, within your WordPress installation's plugins/ directory: git clone https://github.com/UCF/Today-Utilities.git

2. cd into the new Today-Utilities directory, and run npm install to install required packages for development into node_modules/ within the repo

3. Optional: If you'd like to enable BrowserSync for local development, or make other changes to this project's default gulp configuration, copy gulp-config.template.json, make any desired changes, and save as gulp-config.json.

   To enable BrowserSync, set sync to true and assign syncTarget the base URL of a site on your local WordPress instance that will use this plugin, such as http://localhost/wordpress/my-site/. Your syncTarget value will vary depending on your local host setup.

   The full list of modifiable config values can be viewed in gulpfile.js (see config variable).

4. Run gulp default to process front-end assets.

5. If you haven't already done so, create a new WordPress site on your development environment to test this plugin against, and install and activate all plugin dependencies.

6. Activate this plugin on your development WordPress site.

7. Run gulp watch to continuously watch changes to scss and js files. If you enabled BrowserSync in gulp-config.json, it will also reload your browser when plugin files change.

Other Notes

• This plugin's README.md file is automatically generated. Please only make modifications to the README.txt file, and make sure the gulp readme command has been run before committing README changes. See the contributing guidelines for more information.

Contributing

Want to submit a bug report or feature request? Check out our contributing guidelines for more information. We'd love to hear from you!