=== Ultimate FAQ - WordPress FAQ and Accordion Plugin ===
Contributors: Rustaurius, EtoileWebDesign
Tags: faq, faqs, accordion, woocommerce faq, gutenberg faq, faq block
Requires at least: 5.0
Tested up to: 5.9
Stable tag: 2.1.13
License: GPLv3
License URI: http://www.gnu.org/licenses/gpl-3.0.html

FAQ and accordion plugin with easy to use Gutenberg blocks, shortcodes and widgets. Includes an advanced FAQ search and FAQ schema.

== Description ==

FAQ plugin for WordPress. With this plugin you can easily create FAQs and add them to your WordPress site using a Gutenberg block or shortcode. It makes use of a custom post type for seamless FAQ integration on any site. 

[FAQ Demo](https://www.etoilewebdesign.com/ultimate-faq-demo/)

### Key Features

* Create unlimited FAQs
* Create unlimited FAQ tags and FAQ categories
* FAQ block (Gutenberg)
* FAQ shortcode
* Responsive accordion layout that will fit any site and any device
* Ordering and sorting options for your FAQ page
* Group FAQ options
* Translation ready (all strings localized and .pot file included)
* Bulk import FAQs from a spreadsheet
* Insert custom CSS to style your FAQ layout

This plugin is very user friendly and comes with a guided walk-through. When you activate the plugin, it will run and help you create your first FAQs, create an FAQ page and also set some important options!

### FAQ Gutenberg Block, Shortcode and Widget

* Just add the <em>Display FAQs</em> Gutenberg block on any page to display your FAQs
* Or, if you're using a different visual composer or page builder, or the Classic Editor plugin, just add the following shortcode anywhere on any page
`[ultimate-faqs]
`
* The plugin also comes with a widget to display your FAQs in any widgetized area in your theme.

### Video Introduction to the Ultimate FAQ Plugin

[youtube https://www.youtube.com/watch?v=xeGVZnVrZ6I]

### Additional FAQ Features

* Microdata / structured data / question schema (in the correct JSON-LD format) to help with SEO
* Choose what elements show for each FAQ (e.g. categories, tags, author, date, etc.)
* FAQ statistics and view count
* Allow people to comment on individual FAQs

### FAQs for WooCommerce (Requires Premium)

* Easily add an FAQ tab to each product page
* Responsive accordion layout that fits seamlessly into any product page
* Create an FAQ category that matches the name of a product or category in your WooCommerce and it will automatically show!
* For more info, please see the following video:

[youtube https://www.youtube.com/watch?v=cH3p0fW4c5o]

### Ultimate FAQ Premium

The premium version of this plugin comes with the following great extra features:

* FAQ search with autocomplete for question titles
* Additional FAQ display styles
* Choose from 15 toggle icon sets for your frequently asked questions
* WP Forms Integration
* Share FAQs on social media
* Select animation options
* Drag and drop precise re-ordering of FAQs
* Add an FAQ submit form to your site, so visitors can suggest their own FAQs and also (optionally) answers
* Admin notification for new FAQ submissions
* Add additional custom fields to your FAQs, such as a text area, file, link, date and more
* Export FAQs to spreadsheet
* Export all FAQs to a PDF to create a user manual
* SEO-Friendly FAQ, category and tag permalinks
* Advanced FAQ styling options
* Change the FAQ permalink slug base

You can find out more information about the premium version of Ultimate FAQ and accessing a <strong><em>free 7-day trial</em></strong> here: [https://www.etoilewebdesign.com/plugins/ultimate-faq/](https://www.etoilewebdesign.com/plugins/ultimate-faq/)

### FAQ Blocks

* <strong>Display FAQs</strong>: Display all FAQs, or only specific categories using the block attributes
* <strong>Popular FAQs</strong>: Displays a number of the most viewed FAQs (5 unless specified)
* <strong>Recent FAQs</strong>: Displays a number of the most recently added FAQs (5 unless specified)
* <strong>Search FAQs</strong>: Display a search form that allows users to find FAQs with a specific string in the title or body of the FAQ post (premium)
* <strong>Submit FAQ</strong>: Display a form that allows users to submit FAQs of their own and, if enabled, enter an answer to their submitted question as well (premium)

### FAQ Shortcodes

* [ultimate-faqs]: Display all FAQs, or only specific categories using include_category and exclude_category attributes (both take a comma-separated list of category slugs)
* [popular-faqs]: Displays a number of the most viewed FAQs (5 unless specified)
* [recent-faqs]: Displays a number of the most recently added FAQs (5 unless specified)
* [select-faq]: Display specific FAQ posts, using the attributes faq_name, faq_slug and faq_id which take comma-separated lists of FAQ post names, slugs and ids respectively
* [ultimate-faq-search]: Display a search form that allows users to find FAQs with a specific string in the title or body of the FAQ post (premium)
* [submit-question]: Display a form that allows users to submit FAQs of their own and, if enabled, enter an answer to their submitted question as well (premium)

### For help and support, please see:

* Our FAQ page, here: [https://wordpress.org/plugins/ultimate-faqs/faq/](https://wordpress.org/plugins/ultimate-faqs/faq/)
* Our installation guide, here: [https://wordpress.org/plugins/ultimate-faqs/installation/](https://wordpress.org/plugins/ultimate-faqs/installation/)
* Our documentation, here: [https://www.etoilewebdesign.com/support-center/?Plugin=UFAQ&Type=FAQs](https://www.etoilewebdesign.com/support-center/?Plugin=UFAQ&Type=FAQs)
* Our tutorial videos, here: [https://www.youtube.com/playlist?list=PLEndQUuhlvSrNdfu5FKa1uGHsaKZxgdWt
](https://www.youtube.com/playlist?list=PLEndQUuhlvSrNdfu5FKa1uGHsaKZxgdWt)
* The Ultimate FAQ support forum, here: [https://wordpress.org/support/plugin/ultimate-faqs](https://wordpress.org/support/plugin/ultimate-faqs)


== Installation ==

1. Upload the 'ultimate-faqs' folder to the '/wp-content/plugins/' directory
2. Activate the plugin through the 'Plugins' menu in WordPress

or

1. Go to the 'Plugins' menu in WordPress and click 'Add New'
2. Search for 'Ultimate FAQ' and select 'Install Now'
3. Activate the plugin when prompted

= Getting Started =

1. To create an FAQ:
    * Click on 'FAQs' in the WordPress admin sidebar menu
    * Click on 'Add New'
    * Enter the FAQ question in the title area and the FAQ answer in the main post content area
    * Set the author name using the 'Author Display Name' field under the main post content area
    * Select and/or create FAQ categories and FAQ tags in the right-side menu
    * Click the 'Publish' button

2. To display FAQs on your site:
    * Place the <em>Display FAQs</em> block or the [ultimate-faqs] shortcode on any page you've created and it will display your FAQs
    * You can display specific FAQs by making use of the [select-faq] shortcode
    * Display a select number of your most popular FAQs using the <em>Popular FAQs</em> block or the [popular-faqs] shortcode
    * Display a select number of your most recent FAQs using the <em>Recent FAQs</em> block or the [recent-faqs] shortcode

3. To include a submit question form:
    * Placing the <em>Submit FAQs</em> block or the [submit-question] shortcode on a page will generate a form that allows your visitors to submit FAQ questions and, if enabled, even suggest FAQ answers for their questions (premium)

4. To include an FAQ search form:
    * Use the <em>Search FAQs</em> block or the [ultimate-faq-search] shortcode to display an FAQ search form on a page. You can even set it so that all FAQs display on the search page and so that typing in the search box filters the results. (premium)

5. Customize your FAQ experience by making use of the many available settings and options, including toggle and accordion modes, FAQ comments, FAQ category grouping (premium) and many styling options (premium).

For a list of specific features, see the FAQ description page here: [https://wordpress.org/plugins/ultimate-faqs/](https://wordpress.org/plugins/ultimate-faqs/).

For help and support, please see:

* Our FAQ page, here: [https://wordpress.org/plugins/ultimate-faqs/faq/](https://wordpress.org/plugins/ultimate-faqs/faq/)
* Our documentation, here: [https://www.etoilewebdesign.com/support-center/?Plugin=UFAQ&Type=FAQs](https://www.etoilewebdesign.com/support-center/?Plugin=UFAQ&Type=FAQs)
* Our tutorial videos, here: [https://www.youtube.com/playlist?list=PLEndQUuhlvSrNdfu5FKa1uGHsaKZxgdWt
](https://www.youtube.com/playlist?list=PLEndQUuhlvSrNdfu5FKa1uGHsaKZxgdWt)
* The Ultimate FAQ support forum, here: [https://wordpress.org/support/plugin/ultimate-faqs](https://wordpress.org/support/plugin/ultimate-faqs)

== Frequently Asked Questions ==

= How do I get my FAQs to show up on my page? =

Try adding the shortcode [ultimate-faqs] to whatever page you'd like to display the FAQ on.

= What are the current FAQ shortcodes? =

* [ultimate-faqs]: display all FAQs, or only specific FAQ categories using include_category and exclude_category attributes (both take a comma-separated list of category slugs)
* [popular-faqs]: displays a number of the most viewed FAQs (5 unless specified).
* [recent-faqs]: displays a number of the most recently added FAQs (5 unless specified).
* [select-faq]: display specific FAQ posts, using the attributes faq_name, faq_slug and faq_id which take comma-separated lists of FAQ post names, FAQ slugs and FAQ ids respectively.
* [ultimate-faq-search]: display an FAQ search form that allows users to find FAQs with a specific string in the FAQ title or body of the FAQ post (premium).
* [submit-question]: display a form that allows users to submit FAQs of their own and, if enabled, enter an FAQ answer to their submitted FAQ question as well (premium).

= What attributes does the [ultimate-faqs] shortcode accept? =

The FAQ shortcode accepts two attributes, "include_category" and "exclude_category". Both take a comma-separated list of FAQ category slugs. For example, to include only FAQs about the Category "Cars" (which has a slug "cars"), you would use:

[ultimate-faqs include_category='cars']

You can now also use the 'include_category_ids' and 'exclude_category_ids' attributes, to let users include categories by ID instead of only by slug

= Can I hide my FAQ categories? =

Yes, you can choose to display or hide FAQ categories on the FAQ settings page.

= Is it possible to re-order my FAQs? =

Currently you can choose between ascending or descending ordering for your FAQ by either Title, Date Created, or Date Modified.

With the premium version, you can use the FAQ drag and drop ordering table to set exactly the order you want for your FAQs.

= How can I make my FAQs sharable over social media? =

On the FAQ settings page you can choose to link to twitter, facebook and more!

= How do I make my FAQs searchable? =

You can use the premium shortcode, [ultimate-faq-search], which displays an AJAX FAQ search form. You can use the "Auto-Complete Titles" option to have a list of all matching FAQ questions pop up when a user has typed 3 or more characters.

= Can I display all FAQs on pageload using the [ultimate-faq-search] shortcode? =

You can add the attribute "show_on_load" to the shortcode, and set it to "Yes" to display all FAQs when the page first loads.

= How do I add FAQs to a WooCommerce product page with the premium version? =

You can add FAQs for either a specific product or for a WooCommerce category.

For a specific product, create an FAQ category with the same name as the product, and then select that category for all of the FAQs you want included on your product page.

For a category of WooCommerce products, create an FAQ category with the same name as the WooCommerce category, and then select that category for all of the FAQs you want included on your product page.

= How do I limit the number of posts generated by a shortcode =

For the [ultimate-faqs], [popular-faqs] and [recent-faqs] shortcodes, you can use the post_count attribute to limit the number of posts shown. For example:

`[ultimate-faqs post_count='9']
`

= How do I customize my FAQs, for example, to change the font? =

You can customize the plugin by adding code to the Custom CSS box on the FAQ settings page, go to the "Custom CSS" box. For example to change the font you might want to add something like:

.ufaq-faq-title h4, .ufaq-faq-category-title h4  {font-family:"Palatino Linotype", "Book Antiqua", Palatino, serif;}

You can also use the "Styling" area of the "Options" tab if you're using the premium version, which has a bulit-in color picker for FAQ color fields and more!

For more questions and support you can post in the support forum:
<https://wordpress.org/support/plugin/ultimate-faqs>

= Videos =

Video 1 - Shortcodes and Attributes
[youtube https://www.youtube.com/watch?v=zf-tYLqHpRs]

Video 2 - Categories and Tags
[youtube https://www.youtube.com/watch?v=ZV4PM0M1l7M]

Video 3 - FAQs Ordering
[youtube https://www.youtube.com/watch?v=3gVBuCo7bHU]


== Screenshots ==

1. FAQ demo page - Default display style
2. Example of the "Color Block" FAQ display style
3. Example of the "Block" FAQ display style
4. The AJAX FAQ search shortcode in use
5. Simple user submitted FAQs form
6. All answers displayed in the 'list' FAQ mode
7. WooCommerce product page with "FAQs" tab
8. Example of FAQ page with custom FAQ font icons
9. FAQ with comments enabled
10. FAQ with ratings enabled
11. FAQ with post author and date displayed
12. FAQ social sharing
13. Mobile view of FAQs
14. Ultimate FAQs plugin dashboard
15. Admin area showing all FAQs with their number of views as well as their categories
16. View of custom fields on the FAQ post edit screen
17. FAQ tab in WooCommerce product edit
18. FAQ Categories
19. FAQ Tags
20. "Basic" area of the "Settings" tab
21. "Premium" area of the "Settings" tab
22. "Ordering" area of the "Settings" tab
23. "Fields" area of the "Settings" tab
24. "Labelling" area of the "Settings" tab
25. "Styling" area of the "Settings" tab
26. FAQ widgets


== Changelog ==

= 2.1.13 (2022-05-17) =
- Added previews for Gutenberg blocks (i.e. when, on the page edit screen, you add the block, it will show a preview).

= 2.1.12 (2022-05-04) =
- Added a setting to choose/set an FAQ page (as an alternative option to manually putting the block or shortcode on a page).
- Implemented an option to highlight the search term in the results.
- Multiple admins can now be emailed on question submission (comma-separated).
- The "No Results Found" text is now wrapped in a selector, so you can style it separately, if desired.
- FAQ Category Toggle now has a title attribute. It also has a tabindex="0" attribute so that the toggle div can be selected via the keyboard.
- Added a small delay before fetching search results, so that, if someone is typing a query, less requests are being sent to the server.
- Updated the X button that clears the search field, so that it sets the display back to no FAQs or all FAQs, depending on which option you have specified.
- Fixed an issue causing date and datetime custom fields to show an incorrect input type on the FAQ edit screen.
- FAQs set to Private now display on the front end when you are logged in to the site.
- Removed some extra blank spaces that were showing in textarea edit fields.

= 2.1.11 (2022-03-01) =
- Fixed an issue causing invalid schema (structured data).

= 2.1.10 (2022-02-23) =
- Updated WPForms integration, so you can now specify a minimum character count before matching FAQs show.
- Removed Gutenberg block code from the output of the post body in the structured data. 
- Fix for structured data not output on FAQ search page.
- Fix for issue in which, when using the ordering table, editing the FAQ that was at the top would send it to the bottom.

= 2.1.9 (2022-02-01) =
- Fixed compatibility issue when using block-based themes.

= 2.1.8 (2022-01-26) =
- Updated escaping function to correct issue with the widget output.

= 2.1.7 (2022-01-19) =
- Added a new filter (ewd_ufaq_kses_allowed_html) to specify allowed tags for the FAQ answer/body.

= 2.1.6 (2022-01-05) =
- Fixed an issue causing the YouTube block to not output on the front end in an FAQ post.

= 2.1.5 (2022-01-04) =
- Updated class naming issues.
- Fixed a few styling issues with the walk-through.

= 2.1.4 (2021-12-29) =
- Updated sanitizing and escaping.

= 2.1.3 (2021-12-24) =
- Updated sanitizing and escaping.
- Added stable tag.

= 2.1.2 (2021-12-23) =
- Updating nonce and capability checks for AJAX calls.
- Updating sanitization and escaping.

= 2.1.1 (2021-12-22) =
- Fixed an issue in which the defaults were not being correctly set for a few options.

= 2.1.0 (2021-12-21) =
- Changed how premium settings areas are previewed.
- CSS styling update for the FAQ Details area on the FAQ edit screen. 

= 2.0.26 (2021-12-13) =
- Added a notice pertaining to the requirement of the premium helper plugin to access premium settings and content.

= 2.0.25 (2021-11-03) =
- Updates the SAP library to version 2.6.1
- Updates setting's so that a number display only conditionally on other settings' values
- Fix for the 'X' in the search box not re-triggering the AJAX search

= 2.0.24 (2021-10-07) =
- Adds in error handling for when the display_faq isn't defined 
- Adds in additional checks to prevent a console errors when the plugin JS files are loaded without the default localization data being defined.

= 2.0.23 (2021-09-17) =
- Updated how secondary assets are conditionally enqueued.
- Adds in a check to prevent a console error when the plugin JS files are loaded without the default localization data being defined.

= 2.0.22 (2021-09-08) =
- Updated the settings page library.
- Made FAQ search input field type search, so it includes functionality such as the clear event.
- Updated the conditional enqueuing of assets.
- Update to the integration with the Ultimate WP Mail plugin for the submitted FAQ thank-you email.
- Added ID to the category headings (when grouping FAQs by category), so you can anchor link directly to one.
- Added a check on FAQ import for the post type, so you can't accidentally overwrite an existing post if you mistakenly specify a post ID that already exists for a post in another post type.

= 2.0.21 (2021-08-12) =
- Updated deprecated block_categories.

= 2.0.20 (2021-07-21) =
- Updating a condition to account for a possible notice create by a rare use of the_content filter.

= 2.0.19 (2021-06-24) =
- Fixed an issue in which FAQs that were imported would not display on the front end until manually updated. 

= 2.0.18 (2021-06-21) =
- Fixed an issue with incorrect permalinks in search results.
- Fixed an issue in which emails from Ultimate WP Mail were not available for selection.
- Fixed an issue in which <style> tags were being included even if no custom CSS was provided.
- Eliminated a PHP notice. 
- Added a German translation file that was provided by a user of the plugin.

= 2.0.17 (2021-05-14) =
- Fixed an issue causing the AJAX dynamic search results to not automatically show when typing when auto complete was disabled.
- Fixed a conflict between multiple shortcodes listed on the search page. Please, you still should not have any extra shortcodes on your search page other than the one search shortcode!
- Fixed issue with incorrect tag and category links on single post page.

= 2.0.16 (2021-05-10) =
- Fixed an issue in which the wrong URL was being generated for tag links when pretty permalink was enabled.
- Added an option to disable front-page canonical redirects if you are using your homepage as your FAQ page.

= 2.0.15 (2021-05-05) =
- Fixed an issue in which the "FAQs per page" wasn't populating subsequent pages when "Group FAQs by Category" was enabled.

= 2.0.14 (2021-04-29) =
- Fixed an issue causing it to sometimes take two clicks to open an FAQ when accordion was enabled and you were using a reveal effect.
- Set the default sort order for the popular-faqs shortcode to descending.

= 2.0.13 (2021-04-23) =
- Fixed an issue in which permalinks were not correctly redirecting if you had the destination set to the main FAQ page and pretty permalinks enabled.

= 2.0.12 (2021-04-22) =
- Added workaround for missing formatting when using Elementor due to the way they filter the content.
- Removed "Expand All" button from single FAQs.
- Fixed a display issue, where "Expand All" was displaying instead of "Collapse All" when display_all_faqs was being used.
- Eliminated a notice. 

= 2.0.11 (2021-04-20) =
- Fixed incorrect URL for category links in FAQ search result
- Fixed link type custom fields not abiding the Hide Blank setting
- Fixed issue with link type custom fields not being formatted as a link on the front end

= 2.0.10 (2021-04-19) =
- Corrected console JS error on admin Dashboard page.
- Updated admin enqueuing conditions.

= 2.0.9 (2021-04-15) =
- Fix for fatal error happening on plugin update.
- <strong>If you are updating from a pre-2.0.0 version of the plugin, you may have to manually re-activate the plugin after running the update.</strong>

= 2.0.8 (2021-04-14) =
- Workaround for infinite loop issue caused by SiteOrigin Page Builder's application of content filtering.

= 2.0.7 (2021-04-14) =
- Fixed the duplicate entry on the Plugins screen
- Fixed an issue with the FAQ Elements Order setting/table that was causing a warning and for it to sometimes not display the correct order

= 2.0.6 (2021-04-14) =
- Fix for the plugin deactivating when updating from pre-2.0.0

= 2.0.5 (2021-04-13) =
- Fixed an issue where, when a single FAQ is linked to, the plugin was no longer scrolling to it.
- Fixed incorrect path for loading plugin text domain.
- Added the ability for the display_all_answers and group_by_category settings, for the View.FAQs class, to be filtered. This will allow you to override the default settings, to (among other things) do something like make an FAQ start closed even if it's the only one displaying. You can see the following for an example: https://pastebin.com/gZXFcmtw

= 2.0.4 (2021-04-12) =
- Update to the structured data to make it so that, if you have multiple instances of the shortcode on the same page, it will combine the data from all of them and output only one FAQPage schema.
- Fixes an issue with filtered FAQ content being displayed on archive pages.

= 2.0.3 (2021-04-09) =
- Disables group-by-category if there's only a single FAQ, which rectifies issue of duplicates showing on single post page.

= 2.0.2 (2021-04-08) =
- When using the "include_category" attribute while having "Group FAQs by Category" enabled, FAQs that are included in multiple categories will only be displayed in the categories specified in the "include_category" attribute.
- Generated a new .pot file.

= 2.0.1 (2021-04-07) =
- <strong>Please double check after updating to see if the plugin was automatically re-activated. If not, you just need to manually click the Activate button.</strong>
- Fixed an issue causing the "Share" label to show when it shouldn't
- Fixed an issue causing new FAQs to not display in the order table
- Fixed an issue causing the order set in the order table to not apply on the front end
- Changed default slug base back to the correct "ufaqs"
- Removed the border that was now appearing by default around the toggle symbol

= 2.0.0 (2021-04-06) =
- <strong>This update includes quite a big change to the construction of the plugin, so please take caution and test before updating on a live site (or wait a few days before updating in case some minor corrective updates need to be released).</strong>
- <strong>Please also double check after updating to see if the plugin was automatically re-activated. If not, you just need to manually click the Activate button.</strong>
- Rebuilt the plugin, from the ground up, to be object oriented.
- Updated the structure of the settings pages.
- Fixed an issue with the WooCommerce integration causing other tabs to not display.
- Fixed an issue with reveal effects not working.
- Fixed issues with custom field importing.
- If there's only a single FAQ being displayed, it will automatically display opened
- CSS/styling updates, including for columns and WP Forms integration.
- Updates to several styling options.
- Updates to several option descriptions, to clarify them.
- Updated the conditional loading of CSS and JS assets. 
- Added labelling option.
- Cleaning up/removing unnecessary code and files.
- Eliminating notices.
- JS localization.
- Updated .pot file. (If you have created a translation based on the old version, you might need to just update your .po file for this new version.)

= 1.9.12 =
- Fixing an issue in which tabs and content from other sources were not showing in WooCommerce tabs

= 1.9.11 =
- Updated .pot file for translations.
- Update to plugin name and description to clarify purpose and use.

= 1.9.10 =
- Further update for the feedback notice due to user who seems to still not be able to dismiss it.

= 1.9.9 =
- Corrects recent issue causing the feedback notice to not dismiss correctly

= 1.9.8 =
- Updated plugin documentation to take into account features that have been modified and added recently, and to more accurately reflect the current version of the plugin.

= 1.9.7 =
- CSS updates for the admin
- Updating plugin and author links to the current correct URLs
- Small change in the name to make purpose of plugin more clear

= 1.9.6 =
- Adding labelling option

= 1.9.5 =
- Correcting/eliminating several PHP notices
- Updating the version of FPDF used to 1.82

= 1.9.4 =
- Update to correct a potential minor XSS vulnerability

= 1.9.3 =
- CSS update for the admin styling options page layout
- Clarifying the purpose of the plugin in the name

= 1.9.2 =
- Small CSS update for admin options page layout

= 1.9.1 =
- Added extra security to the import feature.

= 1.9.0 =
- Added a new feature to integrate with WP Forms. Now you can set a field in your WP Forms contact form to automatically suggest and display FAQs when someone starts typing their message.
- Corrected an issue where the FAQ search was sometimes not working when the auto complete option was disabled.
- Corrected an issue where sometimes the post count did not return correctly if the same post matched for multiple words.