mageprince / module-faq
mageprince/module-faq
Magento2 FAQ Module
Magento 2 FAQ
This module adds an easy and efficient way to integrate a comprehensive FAQ section into your Magento store using a jQuery Accordion layout. It allows the admin to create and manage FAQs and organize them into groups, each with its own icon for better visual distinction. With a rich WYSIWYG editor, admins can enhance FAQ answers by adding widgets, static blocks, images, and more. The module streamlines customer support by making key information easily accessible in a user-friendly and interactive format.
✨ Features
- Display all FAQs or FAQs by group on CMS pages and static blocks
- Enable AJAX-based FAQ loading on group selection for a seamless frontend experience
- Define a custom URL for the FAQ page
- Full GraphQL support to retrieve all FAQs, FAQs by group ID, and FAQ groups
- Create and manage FAQ groups (categories) with editing capabilities
- Provide detailed FAQ answers using a rich WYSIWYG editor
- Assign store view visibility to individual FAQs and FAQ groups
- Restrict FAQ and group visibility by customer group
- Organize FAQs into groups for better navigation and user experience
- Lightweight and easy-to-install extension with no impact on site performance
- Supports multistore environments
- Add custom icons to FAQ groups
- Support for inserting images, static blocks, and widgets in FAQ answers
- Support for collapse/expand view toggle on the FAQ page
- Hyva compatible
Check full description and user guid on Magento Marketplace
📺 Demo
🚀 Installation Instructions
1. Install from Magento Marketplace
2. Install via composer (packagist.org)
Run the following Magento CLI commands:
composer require mageprince/module-faq
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
3. Manual Installation
Copy the content of the repo to the Magento 2 app/code/Mageprince/Paymentfee
Run the following Magento CLI commands:
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
GraphQL
Get all FAQs
query faqs {
faqs {
faq_id
title
content
group
storeview
customer_group
sortorder
status
created_at
updated_at
}
}
Get FAQs by Group ID:
query faqs {
faqs(groupId: 1) {
faq_id
title
content
group
storeview
customer_group
sortorder
status
created_at
updated_at
}
}
Get all FAQ Groups
query faqs {
faqGroups {
faqgroup_id
groupname
icon
storeview
customer_group
sortorder
status
created_at
updated_at
}
}
How to Display FAQs in CMS Pages or Static Blocks
1. To show all FAQ
{{block class="Mageprince\Faq\Block\Index\Index" template="Mageprince_Faq::faq_main.phtml" show_group_title=1 show_group=1 page_type="scroll"}}
2. To show FAQ by group
{{block class="Mageprince\Faq\Block\Index\Index" template="Mageprince_Faq::faq_main.phtml" group_id=1 show_group_title=1}}
🤝 Contribution
Want to contribute to this extension? The quickest way is to open a pull request on GitHub.
🛠 Support
If you encounter any problems or bugs, please open an issue on GitHub.
📸 Screenshots
No changelog yet
The vendor hasn't published a changelog. Tagged releases appear in the Versions tab.
| Version | Stability | QA Status | Compatibility | Released |
|---|---|---|---|---|
| 2.1.8 | stable | Fail | Magento 2.4.7-2.4.9 Details | 2026-05-20 13:45:40 |
| 2.1.7 | stable | Not tested | Not yet tested Details | 2026-01-11 07:21:16 |
| 2.1.6 | stable | Not tested | Not yet tested Details | 2025-05-19 16:11:06 |
| 2.1.4 | stable | Not tested | Not yet tested Details | 2024-04-18 10:26:38 |
| 2.0.9 | stable | Not tested | Not yet tested Details | 2021-05-24 17:32:45 |
| 2.0.8 | stable | Not tested | Not yet tested Details | 2021-01-19 15:54:30 |
| 2.0.7 | stable | Not tested | Not yet tested Details | 2020-12-12 06:18:51 |
| 2.0.1 | stable | Not tested | Not yet tested Details | 2020-04-25 06:34:42 |
| 2.0.0 | stable | Not tested | Not yet tested Details | 2020-03-22 10:35:56 |
| 1.0.7 | stable | Not tested | Not yet tested Details | 2020-03-04 06:49:21 |
| 1.0.5 | stable | Not tested | Not yet tested Details | 2019-11-24 17:10:28 |
| 1.0.0 | stable | Not tested | Not yet tested Details | 2018-08-03 18:46:59 |
No dependencies declared
This package's composer.json doesn't declare any required, suggested, replaced, or conflicting packages.
Compatibility
Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.
Code Quality
Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge. A phpcs finding can't make a module incompatible.
Static analysis
Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.
| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Warning | 8 | 8 warnings (ruleset: Magento2) — 8 auto-fixable with phpcbf |
| PHPMD | Warning | 8 | 8 rule violations (IfStatementAssignment:7, UnusedFormalParameter:1) |
| Cpd | Pass | 0 | |
| Composer validate | Info | 1 | valid; 1 advisory note (composer validate --strict) |
PHPStan
Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases.
Tests
Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.
Unit tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | ||
| 2.4.8 | N/A | N/A | ||
| 2.4.9 | N/A | N/A |
Integration tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | ||
| 2.4.8 | N/A | N/A | ||
| 2.4.9 | N/A | N/A |
Security
Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.
More from mageprince
View vendorMagento 2 Content Generator Extension
Magento2 Buy Now Module
Magento 2 Add Extra Fee To Order
Magento 2 Log Viewer Extension
Turn an existing module into recurring revenue.
If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.
