ucf / ucf-faq-cpt

v2.2.1 2025-08-13 17:05 UTC

Requires

• composer/installers: ~1.0

Unknown License

Published on Packagist.org on 2026-10-20 18:17 UTC

README

Description

Provides a custom post type for describing FAQs and creates supporting shortcodes. This plugin supports the UCF Athena Framework (Required by the Topic list's "card" layout, and optionally for the FAQ list "classic" layout).

The following templates can be overwritten in the plugin.

• single-faq.php
• archive-faq.php
• taxonomy-topic.php

Installation

Manual Installation

1. Upload the plugin files (unzipped) to the /wp-content/plugins directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the "Plugins" screen in WordPress]

WP CLI Installation

1. $ wp plugin install --activate https://github.com/UCF/UCF-FAQ-CPT/archive/master.zip. See WP-CLI Docs for more command options.

Required Plugins

These plugins must be activated for the plugin to function properly.

• Advanced Custom Fields PRO

Supported Plugins

The plugins listed below are extended upon in this plugin--this may include custom layouts for feeds, style modifications, etc. These plugins are not technically required on sites running this plugin, and shouldn't be activated on sites that don't require their features. A plugin does not have to be listed here to be compatible with this plugin.

• UCF Spotlight

Configuration

• Import field groups (dev/acf-fields.json) using the ACF importer under Custom Fields > Tools.

Changelog

2.2.1

Bug Fixes:

• Corrected a small syntax error that was causing issues with the JSON+LD process when the shortcode was used.

2.2.0

Enhancements:

• Changed method of generating and outputting JSON+LD data to utilize a global variable, gather the FAQ objects within it, then output them to a script tag in the wp_footer action.

2.1.1

Bug Fixes:

• Corrected a bug having to do with the add_json_data setting.

2.1.0

Enhancements:

• Added logic to output JSON+LD structure data for FAQs

2.0.4

Enhancements:

• Added composer file.

2.0.3

Accessibility Fixes

• Updated question tags from h3 to strong
• Updated title to h2 tags instead of h2

2.0.2

Enhancements:

• Adjusted link underline styles in card layouts for FAQs and topics to support Athena v1.1.1+
• Adjusted text colors on FAQ question links and inner card contents to better support usage of FAQ lists against dark backgrounds with light text, e.g. .bg-inverse
• Upgraded packages

2.0.1

Bug Fixes:

• Fixed incorrect early usage of conditional query tags and get_query_var() in ucf_faq_sort_order().

Enhancements:

• Upgraded packages

2.0.0

Enhancements:

• (Breaking change) Updated Handlebars and Typeahead to enqueue by default, since those were incorrectly set to not enqueue out of the box. To do this, the existing Typeahead/Handlebars enqueue options have been completely removed and replaced with new options. You'll need to adjust these settings again if you depend on these scripts not being enqueued.
• (Breaking change) Renamed Handlebars/Typeahead script handles for consistency with our other plugins
• Implemented late JS enqueueing, so that only pages that utilize the [ucf-faq-search] shortcode will load dependent JS files
• Renamed ucf-faq-script.min.js to ucf-faq-search.min.js for clarity
• Split out existing Common and Shortcode classes into their own separate files
• Added a display function for FAQ searches for consistency with other shortcodes
• Upgraded packages; added Github issue/PR templates and CONTRIBUTING doc

Bug fixes:

• Fixed issue with the handlebars_handle option being formatted as a boolean instead of enqueue_handlebars
• Fixed option_{$option_name} hook to actually work + use the correct option name
• Added default_option_{$option_name} hook to ensure defaults values get returned by get_option() when a unique default param isn't passed in

1.3.0

Enhancements:

• Added the ucf-faq-search shortcode

1.2.0

Enhancements:

• Adds the option to add structured microdata to FAQs.

1.1.6

Enhancements:

• Added option that sets the default sort order values to new FAQs to a very high number, which pushes them to the bottom of sorted FAQ lists.

1.1.5

Enhancements:

• Added REST API endpoint for FAQs

1.1.4

Enhancements:

• Added a Resource Link Search layout specifically for FAQs.

1.1.3

Enhancements:

• Appended plugin version number to enqueued stylesheet to ensure cache-busting between releases
• Reduced font size of FAQ questions to match Athena Framework font sizing at mobile

Bug fixes:

• Fixed issue with FAQ sort order values not working as expected

1.1.2

Enhancements:

• Moved collapse classes/attrs up to the FAQ's parent <a> tag to prevent issues with misclicks opening the single FAQ post instead of toggling the accordion
• Added aria-expanded attr to FAQ collapse links for improved accessibility

1.1.1

• Added ability to customize (and remove) View All FAQs call-to-action button on FAQ lists (footer_cta_text and footer_cta_url shortcode params). Either of these new shortcode params can be set to a blank value (e.g. footer_cta_text="" to disable the button entirely.)

1.1.0

• Upgraded packages to latest versions
• Moved topic and question fields to code
• Fixed pagination on admin FAQ list views
• Added line-height style to .ucf-faq-question

1.0.1

• Fixed a debug log message

1.0.0

• Initial release

Upgrade Notice

2.0.0

Breaking changes:

• Updated Handlebars and Typeahead to enqueue by default, since those were incorrectly set to not enqueue out of the box. To do this, the existing Typeahead/Handlebars enqueue options have been completely removed and replaced with new options. You'll need to adjust these settings again if you depend on these scripts not being enqueued.
• Renamed Handlebars/Typeahead script handles for consistency with our other plugins

Installation Requirements

None

Development & Contributing

NOTE: 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.