Skip to content

DogByteMarketing/faq-schema-shortcode

Repository files navigation

FAQ Schema Shortcode Banner

Description

FAQ Schema Shortcode is a WordPress plugin that allows you to easily add FAQ sections to your site using simple shortcodes. It automatically generates structured data (JSON-LD schema) for each FAQ, helping search engines better understand your content and improving your site's SEO with rich results. By using the [faqs_dbm] and [faq_dbm] shortcodes, you can quickly create FAQs that are both user-friendly and SEO-friendly, enhancing your site's visibility in search engines.

Example Usage

[faqs_dbm]
[faq_dbm q="What color is the sky?" a="Blue"]
[faq_dbm q="What color is grass?" a="Green"]
[/faqs_dbm]

Features

  • [NEW] Content FAQs section within backend editor to add FAQs using HTML across all post types and also article categories and product categories. (posts, pages, products, product_cat, ect)
  • Shortcode alias for when you do not have any other shortcodes using [faqs] and [faq] then you can enable this feature in the settings.
  • Customizable Question and Answer labels
  • Accordion option to let users toggle FAQs open and closed
  • Accordion background color, background hover color, and text color options
  • Add additional CSS

Installation

  1. Backup your WordPress site.
  2. Upload the plugin files to the /wp-content/plugins/ directory, or install the plugin through the WordPress plugins screen directly.
  3. Activate the plugin through the 'Plugins' screen in WordPress.

Frequently Asked Questions

What is the shortcode for displaying FAQs?

Use [faqs_dbm] as the container shortcode and [faq_dbm q="Your question?" a="Your answer."] for each individual FAQ item. Wrap the individual items inside the container like this:

[faqs_dbm]
[faq_dbm q="What is this plugin for?" a="It helps you display FAQs with JSON-LD schema for SEO."]
[/faqs_dbm]

Can I use a simpler shortcode like [faqs] and [faq]?

Yes, enable the "Shortcode Alias" option in the plugin settings. This will allow you to use [faqs] and [faq] instead of the default [faqs_dbm] and [faq_dbm].

How do I enable accordion functionality?

Go to Settings > FAQ Shortcode, and check the box labeled Accordion. This makes the FAQ entries collapsible and expandable.

How can I change the accordion colors?

In the settings page, you can set:

  • Text color
  • Background color
  • Background hover color
    Just enter valid HEX values (like #ff0000) for each.

Does this plugin add FAQ schema for SEO?

Yes! It automatically generates JSON-LD structured data so search engines like Google can understand and feature your FAQs.

Can I use HTML in the question or answer?

Yes, but it's sanitized. Only the following tags are allowed in the answers:

  • <a> with href, title, and target
  • <strong>
  • <em>
  • <ol>
  • <ul>
  • <li>

How do I include a link?

You would simply replace the " with ' [faqs] [faq q="How to include a link" a="Just like this"] [/faqs]

Screenshots

Demo Settings

Changelog

1.2.0

  • Added: Content FAQs to give all post types an editor in the backend where you can add FAQs using HTML.
  • Added: Handling for updates
  • Updated: Translations

1.1.1

  • Bugfix: FAQ showing at top of content

1.1.0

  • Added: Setting to customize the question label
  • Added: Setting to customize the answer label
  • Added: Setting to add additional CSS
  • Added: Translation support

1.0.2

  • Updated: FAQs to allow a, em, strong, ol, ul, li

1.0.1

  • Added: Accordion option
  • Added: Accordion text color option
  • Added: Accordion background color option
  • Added: Accordion background hover color option
  • Bugfix: Extra line breaks

1.0.0

  • Initial release.

About

Quickly add FAQ sections compatible with structured data to your WordPress site using simple shortcodes, improving your SEO.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors