mage2kishan / module-faq
Advanced FAQ Module with multi-level assignment capabilities
Requires
- php: ~8.1.0||~8.2.0||~8.3.0||~8.4.0
- mage2kishan/module-core: ^1.0.17
- magento/framework: ^103.0
- magento/module-backend: ^102.0
- magento/module-catalog: ^104.0
- magento/module-cms: ^104.0
- magento/module-store: ^101.0
- magento/module-ui: ^101.0
- magento/module-url-rewrite: ^102.0
README
Magento 2 FAQ Extension: Categories, FAQPage Schema, AJAX Search and Multi-Level Assignment (Hyva + Luma)
Add a full FAQ system to your Magento 2 store. Panth FAQ gives you FAQ categories, a global FAQ page, product page FAQs, category page FAQs, CMS page FAQs, AJAX live search, helpful voting, view-count tracking, and automatic FAQPage JSON-LD schema for Google rich results. Native templates for Hyva (Alpine.js) and Luma are both included.
Product page: kishansavaliya.com/magento-2-faq.html
Quick Answer
What is Panth FAQ? It is a Magento 2 FAQ extension that lets you create FAQ categories and items, assign them to products, catalog categories, and CMS pages, display them in an accordion UI with live search, and output valid FAQPage JSON-LD schema so Google can show your answers as rich results.
What does it add to my store?
- A global FAQ page with category filter tabs, AJAX live search, and an accordion UI.
- Product page FAQs so shoppers can get answers without leaving the PDP.
- Category page FAQs and CMS page FAQs via direct assignment or widget.
- FAQPage JSON-LD schema automatically emitted on every FAQ page for Google rich snippets.
- Helpful voting and view-count tracking per FAQ item.
Which themes are supported? Both Hyva (Alpine.js, no jQuery) and Luma. The right template is picked for you based on the active theme.
What does it need? Magento 2.4.4 to 2.4.8, PHP 8.1 to 8.4, and the free mage2kishan/module-core package.
Need Custom Magento 2 Development?
Get a free quote for your project in 24 hours for custom modules, Hyva themes, performance work, M1 to M2 migrations, and Adobe Commerce Cloud.
Visit our website: kishansavaliya.com | Get a quote: kishansavaliya.com/get-quote
Table of Contents
- Who Is It For
- Key Features
- Compatibility
- Installation
- Configuration
- Admin Management
- Screenshots
- FAQPage Schema
- FAQ Widget
- FAQ
- Support
- About Panth Infotech
- Quick Links
Who Is It For
- Stores with high support volume where a self-service FAQ page reduces repeat questions to your team.
- Merchants selling complex products who want product-specific FAQs on the PDP so shoppers get answers before they add to cart.
- SEO-focused stores that want Google to show their answers as rich snippets from FAQPage structured data.
- Hyva storefronts that need a FAQ system built with Alpine.js, with no jQuery added back in.
- Multi-language and multi-store setups where FAQ content needs to vary by store view.
Key Features
Content Management
- FAQ Categories organize questions into groups with names, descriptions, optional icons, URL keys, and sort order.
- FAQ Items support rich-text answers via the Magento WYSIWYG editor (TinyMCE / Page Builder).
- Multi-level assignment lets you assign one FAQ item to unlimited products, catalog categories, and CMS pages simultaneously. Edit once, update everywhere.
- Per-store-view content overrides so question text, answer, URL key, and meta fields can vary per store view without duplicating items.
- Sort order gives you granular control over question ordering per category and per assignment context.
Frontend Display
- Accordion UI with smooth collapse and expand on click. You can set all items collapsed or all open by default.
- Category filter tabs on the global FAQ page narrow down results to a single FAQ category without a page reload.
- Live client-side search filters visible FAQ items as the visitor types, with debouncing to avoid unnecessary calls.
- AJAX server-side search for stores with hundreds of FAQs, querying a MySQL FULLTEXT index.
- Product page FAQs displayed as a tab or below the product description on the PDP.
- Category page FAQs shown on catalog listing pages.
- CMS page FAQs embedded via direct assignment or the FAQ widget.
- Helpful voting with thumbs-up and thumbs-down buttons per FAQ item. Votes are CSRF-protected and throttled per session.
- View-count tracking increments automatically when a visitor opens an FAQ detail page.
- FAQ detail pages give each item a standalone URL for deep-linking and rich results.
- SEO-friendly category pages at clean URLs like
/faq/orders-shipping.
SEO and Structured Data
- FAQPage JSON-LD schema is output automatically on every FAQ page, including product, category, and CMS page FAQs.
- Per-item SEO fields for meta title, meta description, and meta keywords.
- Per-category SEO fields for meta title, meta description, and meta keywords.
- URL rewrites managed via Magento's URL rewrite system for clean, crawlable URLs.
Developer Experience
- Native Hyva templates built on Alpine.js, no jQuery, no Knockout, no RequireJS.
- Native Luma templates using vanilla JavaScript.
- FAQ widget via
Content -> Widgetsso you can drop FAQ blocks into any Magento container. - Custom CSS field to inject admin-configured CSS without a theme override.
- Constructor DI only, MEQP-style code throughout.
- Translation ready, every label uses Magento's
__()function.
Compatibility
| Requirement | Versions Supported |
|---|---|
| Magento Open Source | 2.4.4, 2.4.5, 2.4.6, 2.4.7, 2.4.8 |
| Adobe Commerce | 2.4.4, 2.4.5, 2.4.6, 2.4.7, 2.4.8 |
| Adobe Commerce Cloud | 2.4.4 to 2.4.8 |
| PHP | 8.1.x, 8.2.x, 8.3.x, 8.4.x |
| Hyva Theme | 1.3+ (native Alpine.js support) |
| Luma Theme | Native support |
| Required Dependency | mage2kishan/module-core ^1.0.17 (free) |
Installation
Composer Installation (Recommended)
composer require mage2kishan/module-faq bin/magento module:enable Panth_Core Panth_Faq bin/magento setup:upgrade bin/magento setup:di:compile bin/magento setup:static-content:deploy -f bin/magento cache:flush
Manual Installation via ZIP
- Download the latest release from Packagist or from the product page.
- Extract it to
app/code/Panth/Faq/in your Magento install. - Make sure
Panth_Coreis installed too (required dependency). - Run the commands above starting from
bin/magento module:enable.
Verify Installation
bin/magento module:status Panth_Faq
# Expected: Module is enabled
After install, open:
Admin -> Stores -> Configuration -> Panth Extensions -> FAQ Settings
Admin -> Panth Infotech -> FAQ -> Manage Items
Admin -> Panth Infotech -> FAQ -> Manage Categories
Configuration
Go to Stores -> Configuration -> Panth Extensions -> FAQ Settings.
| Setting | Group | Default | Description |
|---|---|---|---|
| Enable FAQ | General | Yes | Master toggle for the entire FAQ module. |
| FAQ Page URL Key | General | faq | URL path for the FAQ page (e.g. "faqs", "help", "support"). |
| Items Per Page | Display | 20 | Number of FAQ items shown per page. |
| Show Category Description | Display | Yes | Show the category description above FAQ items on category pages. |
| Show Search Bar | Display | Yes | Show the live search bar on FAQ pages. |
| Show Category Filter | Display | Yes | Show category filter tabs on the global FAQ page. |
| Default Open FAQ Items | Display | No | Expand all accordion items by default instead of collapsing them. |
| Show View Count | Display | No | Show the view count next to each FAQ item. |
| Enable Helpful Voting | Display | Yes | Allow visitors to rate FAQ items as helpful or not helpful. |
| Show on Product Pages | Page Integration | Yes | Display assigned FAQ items on product detail pages. |
| Show on Category Pages | Page Integration | Yes | Display assigned FAQ items on catalog category pages. |
| Show on CMS Pages | Page Integration | Yes | Display assigned FAQ items on CMS pages. |
| Enable FAQ Schema Markup | SEO | Yes | Output FAQPage JSON-LD structured data on FAQ pages for Google rich results. |
| Custom CSS | Custom Styling | (empty) | CSS overrides scoped to .panth-faq-module, no <style> tags needed. |
Admin Management
Open Panth Infotech -> FAQ from the admin menu.
- Manage Items (
faq/item) - create, edit, mass-delete, mass-enable/disable, and mass show/hide from the global FAQ page. Each item has a WYSIWYG answer editor, SEO fields, and assignment grids for products, catalog categories, and CMS pages. - Manage Categories (
faq/category) - create and manage FAQ categories with names, descriptions, optional icons, URL keys, sort order, and per-category SEO fields. - Assignment grids use native Magento UI component grids with filters and checkboxes, so assigning 50 products to one FAQ item is the same as assigning a product to a related products widget.
Screenshots
Live Demo
A full walkthrough: storefront FAQ page, category filter, AJAX search, per-category listing, FAQ detail page, admin grids, edit forms and store configuration.
Storefront
Admin
FAQPage Schema
Panth FAQ outputs valid Google FAQPage structured data as JSON-LD on every FAQ page:
{
"@context": "https://schema.org",
"@type": "FAQPage",
"mainEntity": [
{
"@type": "Question",
"name": "How long does shipping take?",
"acceptedAnswer": {
"@type": "Answer",
"text": "Standard shipping takes 3-5 business days..."
}
}
]
}
This enables rich results in Google Search, which can raise click-through rates. Schema output can be toggled per store scope under SEO Settings.
FAQ Widget
Drop FAQ blocks into any Magento container via Content -> Widgets:
- Create a new widget and select Panth FAQ -- FAQ Block.
- Configure: select an FAQ category, set a max item count, enable or disable search.
- Assign to a CMS page, CMS block, or layout container.
How It Works
- You create FAQ categories in Panth Infotech -> FAQ -> Manage Categories.
- You create FAQ items in Panth Infotech -> FAQ -> Manage Items, write a WYSIWYG answer, and assign the item to one or more products, catalog categories, or CMS pages using the assignment grids on the edit form.
- On the global FAQ page, Magento renders all active items grouped by category, with filter tabs and a search bar.
- On a product detail page, category page, or CMS page, the module checks whether any FAQ items are assigned to that entity and renders them in an accordion block.
- Every FAQ page outputs FAQPage JSON-LD schema in the page head automatically.
- When a visitor opens an FAQ detail page, the view count increments. When they vote helpful or not helpful, the vote is recorded with CSRF protection and session-based throttling.
FAQ
Does Panth FAQ work with Hyva themes?
Yes. Panth FAQ ships native Alpine.js templates for Hyva, with no jQuery, Knockout, or RequireJS. The module reads the active theme through Panth_Core and serves the Hyva template automatically.
Does the FAQPage schema work on product pages?
Yes. When you assign FAQs to a product and the module renders them on the PDP, it also outputs FAQPage JSON-LD for those items. Google's guidelines allow this alongside the product's own Product schema.
Can the same FAQ item appear on multiple products?
Yes. Assignment is many-to-many. One FAQ item can be assigned to unlimited products, catalog categories, and CMS pages at the same time. Edit the item once and every assigned location reflects the change.
Does AJAX search work with a large FAQ set?
Yes. The AJAX search endpoint queries a MySQL FULLTEXT index on the server side, so stores with hundreds of FAQ items get fast results without loading all content into the browser.
Does Panth FAQ support multi-store and multi-language?
Yes. FAQ items and categories use store-view scoping. From version 1.1.0, per-store-view content overrides let you change the question, answer, URL key, and meta fields per store view without duplicating items. All user-facing labels use Magento's __() function.
Will helpful voting create a spam problem?
No. Votes are CSRF-protected and throttled per session. Vote counts are shown but individual votes are not exposed publicly.
Can I disable the FAQPage schema?
Yes. Set Enable FAQ Schema Markup to No under SEO Settings. This is useful if another SEO extension already emits schema and you want to avoid duplication.
Does it conflict with other FAQ extensions?
No direct conflicts. Panth FAQ uses its own Panth\Faq namespace, its own database tables (panth_faq_item, panth_faq_category, and relation tables), and its own admin routes.
Does Panth FAQ need Panth Core?
Yes. mage2kishan/module-core ^1.0.17 is a free required dependency that Composer installs for you automatically.
Support
| Channel | Contact |
|---|---|
| Product Page | kishansavaliya.com/magento-2-faq.html |
| kishansavaliyakb@gmail.com | |
| Website | kishansavaliya.com |
| +91 84012 70422 | |
| GitHub Issues | github.com/mage2sk/module-faq/issues |
| Upwork (Top Rated Plus) | Hire Kishan Savaliya |
| Upwork Agency | Panth Infotech |
Response time: 1-2 business days.
Need Custom Magento Development?
Looking for custom Magento module development, Hyva theme work, store migrations, or performance tuning? Get a free quote in 24 hours:
About Panth Infotech
Built and maintained by Kishan Savaliya (kishansavaliya.com), a Top Rated Plus Magento developer on Upwork with 10+ years of eCommerce experience.
Panth Infotech is a Magento 2 development agency that builds high quality, security focused extensions and themes for both Hyva and Luma storefronts. The extension suite covers SEO, performance, checkout, product presentation, customer engagement, and store management, with each module built to MEQP standards and tested across Magento 2.4.4 to 2.4.8.
Browse the full extension catalog on our Magento extensions page or on Packagist.
Quick Links
| Resource | Link |
|---|---|
| Product Page | magento-2-faq.html |
| Packagist | mage2kishan/module-faq |
| GitHub | mage2sk/module-faq |
| Website | kishansavaliya.com |
| Free Quote | kishansavaliya.com/get-quote |
| Upwork (Top Rated Plus) | Hire Kishan Savaliya |
| Upwork Agency | Panth Infotech |
| kishansavaliyakb@gmail.com | |
| +91 84012 70422 |
Ready to add a self-service FAQ to your store?
SEO Keywords: magento 2 faq, magento 2 faq extension, magento 2 faq module, faqpage schema magento 2, faqpage json-ld magento, accordion faq magento 2, hyva faq extension, magento 2 faq categories, magento 2 product page faq, ajax faq search magento 2, magento 2 knowledge base, multi-level faq assignment, magento 2 faq rich results, magento 2 faq helpful voting, magento 2 faq view count, magento 2 faq widget, magento 2 category page faq, magento 2 cms page faq, magento 2 faq hyva alpine, magento 2 faq luma, magento 2.4.8 faq, php 8.4 faq, mage2kishan module-faq, panth faq, panth infotech, hire magento developer, top rated plus upwork, kishan savaliya magento, custom magento development, magento 2 structured data faq, google rich results faq magento











