mageplaza / module-shop-by-brand-graphql
mageplaza/module-shop-by-brand-graphql
Magento 2 Shop By Brand GraphQl Extension
Magento 2 Shop By Brand GraphQL
Magento 2 Shop By Brand GraphQL is now a part of Mageplaza Shop By Brand extension that supports GraphQL features. This supports PWA compatibility with a lot of advantages and convenience. The extension supports getting and pushing data on the website with GraphQl, this support for PWA Studio.
Mageplaza Shop By Brand for Magento 2 enables you to create a separate page to display brands that have products available in your store.
With this kind of showcasing brands, customers who prefer shopping by brand will quickly find the brands they are looking for. When customers type in some first character of their favorite brand in the instant search box, the suggested brands will appear at the drop-down, so you can swiftly pick up your favorite and go to more details of the brand.
With each brand page, there will be essential information included, such as brand description, product description, price, rating, and other attributes. Brand logos can be displayed on the product page as well so that it’s easier for customers to identify their favorite brands. Shop By Brand is integrated with Mageplaza Layered Navigation. Customers can use brand as a product attribute to filter the products they want to buy from a specific brand.
Based on your store’ scale and customers’ demand, you can add as many brands as you want to your store's brand page at once without manual processing one by one. You only need one click to bulk import various brands via a CSV file. The brands will be updated automatically to the brand page with complete information and brand images.
The extension supports you in creating brand listing and brand pages with SEO-friendly URL and custom meta tags. Your pages will be more likely to rank higher on the search engine results page and let more customers know about this exciting feature of your store.
1. How to install
Run the following command in Magento 2 root folder:
composer require mageplaza/module-shop-by-brand-graphql
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy
Note:
Mageplaza Shop By Brand GraphQL requires installing Mageplaza Shop By Brand in your Magento installation.
2. How to use
To perform GraphQL queries in Magento, please do the following requirements:
- Use Magento 2.3.x or higher. Set your site to developer mode.
- Set GraphQL endpoint as
http://<magento2-server>/graphqlin url box, click Set endpoint.
(e.g.http://dev.site.com/graphql) - To view the queries that the Mageplaza Shop By Brand GraphQL extension supports, you can look in
Docs > Queryin the right corner
3. Devdocs
Click on Run in Postman to add these collections to your workspace quickly.

4. Contribute to this module
Feel free to Fork and contribute to this module and create a pull request so we will merge your changes main branch.
5. Get Support
- Feel free to contact us if you have any further questions.
- Like this project, Give us a Star

| Version | Stability | QA Status | Compatibility | Released |
|---|---|---|---|---|
| 1.0.4 | stable | Fail | Not compatible Details | 2022-02-22 02:17:09 |
| 1.0.3 | stable | Not tested | Not yet tested Details | 2021-12-10 08:06:04 |
| 1.0.2 | stable | Not tested | Not yet tested Details | 2020-10-30 09:31:39 |
| 1.0.1 | stable | Not tested | Not yet tested Details | 2020-10-26 04:40:54 |
| 1.0.0 | stable | Not tested | Not yet tested Details | 2020-02-27 01:13:40 |
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 | 21 | 21 warnings (ruleset: Magento2) — 20 auto-fixable with phpcbf |
| PHPMD | Warning | 4 | 4 rule violations (CyclomaticComplexity:1, NPathComplexity:1, UnusedLocalVariable:1, 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. Cell → details modal.
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 mageplaza
View vendorTurn 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.