Skip to content
Jo Dickson edited this page Mar 25, 2020 · 9 revisions

Custom Post Type

  • FAQ

Custom Taxonomy

  • Topic

Shortcodes

[ucf-faq-list]

Lists FAQs, filtered by provided options and grouped by Topic (optional).

Attributes

Name Description Default
layout Name of the registered layout to display the list with.

Options:
  • classic
classic
title Title text displayed above the FAQ list. Set to an empty value to omit the title.
topics One or more Topic term slugs (comma-separated) to filter results by.
tags one or more Tag slugs (comma-separated) to filter results by.
related_tags One or more Tag slugs (comma-separated) to filter related FAQs by. At least one tag must be provided to display a Related FAQs section under the FAQ list.
topic_element HTML tag surrounding the Topic name(s) when grouping by Topic is enabled. h2
topic_class CSS classes added to the Topic name(s) when grouping by Topic is enabled. h4
question_element HTML tag surrounding each question. h3
question_class CSS class added to the question tag.
related_element HTML tag surrounding the Related FAQs title. h3
related_class CSS class added to the Related FAQs title. h4
show If set to true, the FAQ answers will be visible and not collapsed by default. (empty; answers are hidden)
group_by Enables grouping of results by Topic.

Accepted options:
  • topic (group by Topic)
  • (empty; results are not grouped)
topic
order_by_sort_meta If set to true, FAQs will be ordered by their "FAQ Question Sort Order" meta value, ascending, then by title ascending. If set to false, no orderby rule will be applied to the results. true
footer_cta_text Text displayed in the FAQ list's call-to-action button. Setting this to an empty value will prevent the button from being displayed. View All FAQs
footer_cta_url URL that the FAQ list's call-to-action button will link to. Setting this to an empty value will prevent the button from being displayed. /faq/

[ucf-faq-topic-list]

Lists FAQ Topics.

Attributes

Name Description Default
layout Name of the registered layout to display the list with.

Options:
  • classic
  • card (requires Athena Framework)
classic
title Title text to display above the topic list. Set to an empty value to omit the title.
topic_element HTML tag surrounding each Topic. h2
topic_class CSS class added to each Topic tag. h4
Clone this wiki locally