Skip to content

Magento 2 FAQ extension user guide

Introduction

Magento 2 FAQ extension lets you build a library of reusable questions and answers and show them on product, category and CMS pages. Group questions into FAQ blocks, attach the blocks to any number of pages, translate the content for each store view (manually or with AI) and let customers find answers right where they shop.

Requirements and Installation

FAQ extension supports both Community and Enterprise edition of Magento starting from version 2.4. The current version of Magento installed on your website can be found in the lower right corner of any backend page.

The extension has 3 separate ways of installation: via local Composer, by copying the code or using our repository.

1) Copy the code (ready-to-paste package);
2) Use local Composer;
3) Use MageWorx Repository.

Configuration

To configure the extension, log into the Magento Admin panel and go to STORES ⟶ Configuration ⟶ MageWorx tab ⟶ FAQ.

General

  • Enable FAQ - this setting turns the FAQ on the storefront on or off. When it is set to No, no FAQ is shown on the storefront. The admin pages keep working. By default, Yes.

Inline FAQ Editor

These settings control the FAQ section in the admin forms of products, categories and CMS pages. Hiding the section does not delete the FAQ data saved there.

  • Show on Product Form - shows the FAQ section on the product edit page. By default, Yes.
  • Show on Category Form - shows the FAQ section on the category edit page. By default, Yes.
  • Show on CMS Page Form - shows the FAQ section on the CMS page edit page. By default, Yes.

Frontend

  • Visible Answers Per Question - if a question has more answers than this number, the rest are hidden under the "Read more" link. Set 0 to hide all answers until a customer clicks the question. By default, 3.

  • Accordion Mode - Multiple (allow several open) lets customers open several questions at once. Single (only one open at a time) closes the open question when another one is opened. By default, Multiple.

  • Expand/Collapse Answers by Default - defines whether the answers are shown (Expand) or hidden (Collapse) when the page loads. If Accordion Mode is Single and this setting is Expand, only the first question is opened. By default, Collapse.

  • Auto-expand First Question - opens the first question when the page loads. By default, No.

  • Show Block Titles - shows the title and description of each FAQ block as section headers. When set to No, all questions are shown as one list. By default, No.

  • Title - the FAQ title shown on the storefront. On product pages with tabs, this text is used as the tab title.

  • Description - the text shown above all questions and answers.

Performance

  • Cache Lifetime (seconds) - how long the FAQ data is cached. Set 0 to turn caching off. By default, 86400 (24 hours).

AI Translation

These settings are used when you translate questions and answers with AI. The translation works only when the OpenAI API key is entered in STORES ⟶ Configuration ⟶ MageWorx tab ⟶ AI Integration Settings ⟶ Settings ⟶ OpenAI API KEY.

  • AI Model - the AI model used to translate the FAQ. By default, gpt-4.1-mini.

  • Temperature - a value from 0.0 to 2.0. Lower values give more exact and predictable translations. By default, 0.3.

  • Max Tokens - the maximum length of the translation response, in tokens. By default, 2000.

  • Prompt Template - the request sent to the AI. Use {{language}} for the target language and {{content}} for the source text.

  • System Context - the instructions sent to the AI before the prompt.

How it works

The FAQ content consists of three parts:

  • Questions and Answers - reusable texts. The same question or answer can be used in many blocks.
  • FAQ Blocks - groups of question and answer pairs. A block can be attached to products, categories and CMS pages, or added to any CMS content with a widget.

There are two ways to add an FAQ to a page:

  • create an FAQ block and attach it to the page, from the block or from the page;
  • add questions and answers right on the product, category or CMS page form in its FAQ section.

The admin menu is at CONTENT ⟶ FAQ: FAQ Blocks, Questions (Advanced) and Answers (Advanced).

FAQ Blocks

To manage the blocks, go to CONTENT ⟶ FAQ ⟶ FAQ Blocks.

The grid shows the blocks with the following columns: ID, Title, Type, Status, Items (the number of questions and answers in the block), Linked To (how many products, categories, CMS pages and special pages use the block), Sort Order and Updated At. The hidden Auto-generated column marks the blocks created from the FAQ section of a page form. You can filter the grid by ID, type, status, items, sort order and date, and export it to CSV or XML.

Use the Edit action to open a block and Delete to remove it. To create a block, click Add New Block.

General

  • Select Store - the store views where the block is shown on the storefront.
  • Type - the block type: Custom, Product, Category, CMS Page or Special.
  • Is Active - enables or disables the block.
  • Sort Order - the position of the block.
  • Title - the block title. It is required for the default store. On other store views, leave it empty to use the default value.
  • Description - the block description.

Use the store switcher at the top of the page to enter the title and description for a specific store view.

Questions and Answers

This grid holds the question and answer pairs of the block. Each row has:

  • Question and Answer - an existing question and answer.
  • Sort Order - the position of the pair on the storefront.
  • Is Active - enables or disables the pair in this block.

The buttons are:

  • Add Existing Q&A - adds a row where you choose an existing question and answer.
  • Create Q&A and Add Item - opens a window where you write a new question and answer. The new pair is added to the block at once.

If there are no questions or answers yet, Add Existing Q&A opens the creation window.

Preview

This section shows how the block's questions and answers look in the accordion. It is updated while you edit the rows, without saving.

Products, Categories, CMS Pages

These sections let you attach the block to pages from the block itself. Each section has a grid of products, categories or CMS pages with checkboxes. Check the pages that should show the block and save it. When the block is already attached to some pages, the grid opens filtered to them; change the filter to see all pages.

The buttons at the top of the form are Back, Delete, Save and Continue Edit and Save FAQ Block.

Questions

To manage the questions, go to CONTENT ⟶ FAQ ⟶ Questions (Advanced).

The grid shows the columns ID, Question, Status, Used in Blocks and Updated At. To create a question, click Add New Question.

The mass actions are:

  • Delete - deletes the selected questions.
  • Translate - translates the selected questions with AI. Choose a store view, All Store Views (Missing Only) to fill only the empty translations, or All Store Views (Overwrite) to replace the existing ones. The translations are queued and processed in the background.

The question form has the following sections:

General

  • Is Active - enables or disables the question.
  • Question - the question text for the default store view. Required.

Store View Values

One field per store view for the translated question. If a field is empty, the default value is used. When the OpenAI API key is set, each field has a Translate button that fills it with an AI translation, and the Translate All button at the top of the form translates the question into all store views at once. Review the texts and save the question.

  • FAQ Blocks - the blocks where this question should be added.
  • Answers - the answers to pair with this question in the selected blocks.
  • Apply Mode - Merge adds only the missing links. Replace for Selected Blocks removes the current links of this question in the selected blocks and writes the selected answers.

Answers

To manage the answers, go to CONTENT ⟶ FAQ ⟶ Answers (Advanced).

The grid shows the columns ID, Answer, Status, Used in Blocks and Updated At. To create an answer, click Add New Answer. The mass actions Delete and Translate work the same way as for questions.

The answer form has the following sections:

  • General - Is Active and Answer, the answer text for the default store view, with the text editor. Required.
  • Store View Values - the translated answer for each store view, with the same Translate and Translate All buttons as for questions.
  • Question Links - Questions lets you pick the questions this answer belongs to. The answer is added to all FAQ blocks where the selected questions already exist. Apply Mode works the same way as for questions.

FAQ on product, category and CMS page forms

When enabled in the Inline FAQ Editor settings, the edit pages of products, categories and CMS pages get the FAQ section.

  • Add FAQ Blocks - opens a window with a searchable list of FAQ blocks. Check the blocks and click Add Selected. The chosen blocks are listed under Selected FAQ Blocks.

The block links are saved for the store view selected in the scope switcher. Leave the list empty on a store view to use the blocks of the default store.

  • Add FAQ Item - adds a row where you write a question and an answer only for this page. Each row has Question, Answer, Sort Order and Active. The gear button on a row opens the Store View Values window, where you enter the question and answer for each store view.

The questions written here are saved to an auto-generated block of this page. The preview in this section shows the questions of the selected blocks and of the inline rows together, and it is updated without saving.

FAQ widget

To add an FAQ block to any CMS page or static block, open the content editor and use Insert Widget ⟶ MageWorx FAQ Block.

  • FAQ Block - the block to show.
  • Visible Answers Limit - the number of answers shown before the "Read more" link. Leave it empty to use the Visible Answers Per Question setting.

You can add several widgets to one page.

FAQ Import / Export

To move FAQ content between stores or create it in bulk, go to SYSTEM ⟶ Data Transfer ⟶ FAQ Import / Export.

  • Export All FAQ Data (JSON) - downloads all FAQ blocks, questions, answers, store view values and page links as a JSON file. Auto-generated blocks are not exported.

To import, choose the File Format, select the File to Import and click Import.

  • JSON (full export file) - a file made by the export. Use it to move the FAQ to another installation.
  • CSV (block_name, question, answer) - a simple file with three columns. All content is created for the default store. Existing blocks with the same names are reused, and running the same file twice creates no duplicates.
  • Dry run (validate only, no changes) - checks the file without saving anything.

Storefront

The FAQ is shown automatically on the pages it is attached to:

  • on product pages, as the FAQ tab next to the product description and reviews. With the full-width product page layout, it is shown as a section below the product details;
  • on category pages, below the product list;
  • on CMS pages, below the page content.

All questions from all blocks of the page, including the inline rows, are shown as one list sorted by Sort Order. A question used in several blocks is shown once. Customers click a question to see its answers; extra answers are hidden under the "Read more" link.

Each question has its own link anchor, like #faq-question-42. When a customer opens a page with this anchor, the page scrolls to the question, opens it and highlights it for a moment.

The FAQ is not shown if the page has no active blocks or questions for the current store view, or if Enable FAQ is set to No.

Got Questions?

Need help with the extensions? Feel free submit a ticket from https://www.mageworx.com/support/

Mageworx offers outstanding services developing custom-tailored solutions for Magento platform to attain your eCommerce objectives. Our professional impassioned team provides profound and custom oriented development of your project in a short timeframe.