# mageprince/module-faq

> Magento2 FAQ Module

`composer require mageprince/module-faq`

Canonical URL: https://packagento.com/mageprince/module-faq

## At a glance

- **Vendor**: mageprince (https://packagento.com/mageprince.md)
- **Latest version**: 2.1.8 — released 2026-05-20
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/mageprince/module-faq and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require mageprince/module-faq:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Magento2 FAQ Module

## README

[![Latest Stable Version](https://poser.pugx.org/mageprince/module-faq/v)](//packagist.org/packages/mageprince/module-faq)
[![Total Downloads](https://poser.pugx.org/mageprince/module-faq/downloads)](//packagist.org/packages/mageprince/module-faq)
[![Monthly Downloads](https://poser.pugx.org/mageprince/module-faq/d/monthly)](//packagist.org/packages/mageprince/module-faq)
[![License](https://poser.pugx.org/mageprince/module-faq/license)](//packagist.org/packages/mageprince/module-faq)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mageprince/magento2-FAQ/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mageprince/magento2-FAQ/?branch=master)
[![Code Intelligence Status](https://scrutinizer-ci.com/g/mageprince/magento2-FAQ/badges/code-intelligence.svg?b=master)](https://scrutinizer-ci.com/code-intelligence)


## 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
- <a href="https://www.hyva.io/">Hyva</a> compatible

<b>Check full description and user guid on <a href="https://commercemarketplace.adobe.com/mageprince-module-faq.html">Magento Marketplace</a></b>

## 📺 Demo

<b><a href="https://demo.mageprince.com/faq/">Frontend</a>   |   <a href="https://demo.mageprince.com/admin">Backend</a></b>

## 🚀 Installation Instructions

#### 1. Install from Magento Marketplace

[Magento Marketplace Link](https://commercemarketplace.adobe.com/mageprince-module-faq.html)

#### 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

<b>1. To show all FAQ</b>
```
{{block class="Mageprince\Faq\Block\Index\Index" template="Mageprince_Faq::faq_main.phtml" show_group_title=1 show_group=1 page_type="scroll"}}
```
<b>2. To show FAQ by group</b>
```
{{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 <a href="https://help.github.com/articles/about-pull-requests/">open a pull request</a> on GitHub.

## 🛠 Support

If you encounter any problems or bugs, please <a href="https://github.com/mageprince/magento2-FAQ/issues">open an issue</a> on GitHub.


## 📸 Screenshots

![1_faq_page](https://github.com/user-attachments/assets/c041d098-fea4-4cd4-aeb8-8907f6612554)
![3_widget](https://github.com/user-attachments/assets/909d8260-2f77-42e5-ad11-8c4a2d355e34)
![5_group_grid](https://github.com/user-attachments/assets/c2ba51ef-3542-4749-b502-26699a730bc7)
![6_group_edit](https://github.com/user-attachments/assets/59cb03e0-e0e3-430e-9bd5-de99f8c45255)
![7_faq_grid](https://github.com/user-attachments/assets/5b163a90-9994-4c77-a743-b43e8c6141c1)
![9_faq_edit_1](https://github.com/user-attachments/assets/a19091c6-11ca-43e1-84f8-85ed4722c9ed)
![10_faq_edit_2](https://github.com/user-attachments/assets/22e6308d-834d-4a8d-b868-83e765d0ba91)
![11_configuration_1](https://github.com/user-attachments/assets/4ead115b-8d76-4028-800e-7eebccc8df06)
![12_configuration_2](https://github.com/user-attachments/assets/43fe266b-a9cc-4bea-a42a-fac985d7741b)
![13_widget](https://github.com/user-attachments/assets/bffc21d2-629e-4de9-a28c-d73637071ac9)

## Recent Versions

| Version | Released |
|---|---|
| 2.1.8 | 2026-05-20 |
| 2.1.7 | 2026-01-11 |
| 2.1.6 | 2025-05-19 |
| 2.1.4 | 2024-04-18 |
| 2.0.9 | 2021-05-24 |
| 2.0.8 | 2021-01-19 |
| 2.0.7 | 2020-12-12 |
| 2.0.1 | 2020-04-25 |
| 2.0.0 | 2020-03-22 |
| 1.0.7 | 2020-03-04 |

Showing 10 of 12 versions. Full release history on https://packagento.com/mageprince/module-faq.

## Quality

Latest release (2.1.8) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — 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 against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 46 | 46 | – | – |
| 2.4.8 | – | 46 | 46 | – |
| 2.4.9 | – | – | 46 | 46 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### 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

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["mageprince/module-faq"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

mageprince is a Magento 2 vendor on Packagento. See https://packagento.com/mageprince.md for their full catalogue.

