# mageplaza/module-faqs-graphql

> Mageplaza FAQs GraphQl Extension

`composer require mageplaza/module-faqs-graphql`

Canonical URL: https://packagento.com/mageplaza/module-faqs-graphql

## At a glance

- **Vendor**: mageplaza (https://packagento.com/mageplaza.md)
- **Latest version**: 1.1.0 — released 2021-02-23
- **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/mageplaza/module-faqs-graphql 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 mageplaza/module-faqs-graphql:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Mageplaza FAQs GraphQl Extension

## README

**Magento 2 FAQ GraphQL is a part of Mageplaza FAQ extension that adds GraphQL features.** This supports PWA compatibility.

[Mageplaza FAQ for Magento 2](https://www.mageplaza.com/magento-2-faq-extension/) enables you to create a comprehensive FAQ page for your online store where visitors can find answers to questions about your products and services. 

You can build a neat and SEO-friendly FAQ homepage with the most convenience for customers to look up the information. The instant search box is placed in the center of the page, making it easier for customers to search for what they need. The FAQ page will be well-organized and user-friendly by classifying questions into specific categories. The number of questions included in a section is totally determined by the store admin. 

The store admin can configure the question FAQ homepage from the admin backend for SEO optimization. This helps increase the FAQ page search ranking and provides an easy-to-navigate the FAQ page easily. Each category can be customized to be more friendly with users by adding icons or changing the questions, positions of the category. 

The store admin can customize the look of the FAQ page from the backend configuration. It’s easy to change the page title, theme color, page layout, FAQ style, categories columns, and limit the question included in each category.  

### 1. How to install
Run the following command in Magento 2 root folder:

```
composer require mageplaza/module-faqs-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy
```
**Note:** 
Magento 2 FAQ GraphQL requires installing [Mageplaza FAQ](https://www.mageplaza.com/magento-2-faq-extension/) in your Magento installation. 

### 2. How to use 

Mageplaza's FAQ extension enables getting categories, articles, and creating questions through GraphQL. 
To start working with FAQs GraphQL in Magento, you need to: 
- Use Magento 2.3.x. Return your site to developer mode. 
- Install [chrome extension](https://chrome.google.com/webstore/detail/chromeiql/fkkiamalmpiidkljmicmjfbieiclmeij?hl=en) (currently does not support other browsers). 

### 3. Devdocs
- [Magento 2 FAQ API & examples](https://documenter.getpostman.com/view/10589000/SzRxXqod?version=latest) 
- [Magento 2 FAQ GraphQL & examples](https://documenter.getpostman.com/view/10589000/SzRxXqof?version=latest)

Click on Run in Postman to add these collections to your workspace quickly. 

![Magento 2 blog graphql pwa](https://i.imgur.com/lhsXlUR.gif)

### 4. Contribute to this module 
Feel free to **Fork** and contribute to this module.

You can create a pull request, and we will consider to merge your changes in the main branch. 

### 5. Get support 
- Feel free to [contact us](https://www.mageplaza.com/contact.html) if you have any question. We're happy to hear from you. 
- If you find this post helpful, please give us a **Star** ![star](https://i.imgur.com/S8e0ctO.png)

## Changelog

CHANGELOG: https://www.mageplaza.com/changelog/m2-faqs.txt

## Recent Versions

| Version | Released |
|---|---|
| 1.1.0 | 2021-02-23 |
| 1.0.0 | 2020-02-28 |

## Quality

Latest release (1.1.0) 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 | 1 | 1 | – | – |
| 2.4.8 | – | 1 | 1 | – |
| 2.4.9 | – | – | 1 | 1 |


### 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 | 20 | 20 warnings (ruleset: Magento2) — 20 auto-fixable with phpcbf |
| PHPMD | Warning | 1 | 1 rule violation (NPathComplexity: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 | 55 | 55 | – | – |
| 2.4.8 | – | 55 | 71 | – |
| 2.4.9 | – | – | 71 | 71 |


### 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=["mageplaza/module-faqs-graphql"],
  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

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