opengento / module-product-breadcrumbs

opengento/module-product-breadcrumbs

This module allows to toggle server side rendered breadcrumbs for product pages.

magento2-module Compatibility: 2.4.7-2.4.9 Code Quality: Fail Tests: N/A Security: Pass MIT

Product Breadcrumbs Rendering Strategie Module for Magento 2

Latest Stable Version
License: MIT
Packagist
Packagist

This module allows to toggle server side rendered breadcrumbs for product pages.

Setup

Magento 2 Open Source or Commerce edition is required.

Composer installation

Run the following composer command:

composer require opengento/module-product-breadcrumbs

Setup the module

Run the following magento command:

bin/magento setup:upgrade

If you are in production mode, do not forget to recompile and redeploy the static resources.

Features

This module is Hyvä-Ready!

This module render server-sided product breadcrumbs so it's visible to any robot without requiring any js loads and process.
Can you still enable the js breadcrumbs so your user can see natural breadcrumbs following their navigation.

Settings

The settings are available at:

Stores > Configuration > Catalog > Catalog > Search Engine Optimization

  • Render Product Breadcrumbs from Server-Side
  • Override Product Breadcrumbs on Client-Side
  • Product Breadcrumbs Strategy
  • Product Breadcrumbs Excluded Categories

Documentation

  • Toggle server-side product breadcrumbs rendering.
  • Toggle to allow client-side to override product breadcrumbs based on navigation.
  • Select best strategy to generate the product breadcrumbs (native, deepest, closest).
  • Exclude some root categories from being used to generate the breadcrumbs.

Support

Raise a new request to the issue tracker.

Authors

  • Opengento Community - Lead - Twitter Follow
  • Thomas Klein - Maintainer - GitHub followers
  • Contributors - Contributor - GitHub contributors

License

This project is licensed under the MIT License - see the LICENSE details.

That's all folks!

No changelog yet

The vendor hasn't published a changelog. Tagged releases appear in the Versions tab.

Versions
Version Stability QA Status Compatibility Released
2.0.4 stable Fail Magento 2.4.7-2.4.9 Details 2025-06-24 08:59:30
2.0.3 stable Not tested Not yet tested Details 2025-03-12 09:51:37
2.0.2 stable Not tested Not yet tested Details 2024-11-07 20:47:45
2.0.1 stable Not tested Not yet tested Details 2024-11-07 20:34:12
2.0.0 stable Not tested Not yet tested Details 2024-10-15 10:19:08
1.0.2 stable Not tested Not yet tested Details 2024-08-28 21:17:29
1.0.1 stable Not tested Not yet tested Details 2024-08-12 21:13:02
1.0.0 stable Not tested Not yet tested Details 2024-08-11 16:47:43

Requires 6

Package Constraint
php ^8.1
magento/framework *
magento/module-config *
magento/module-store *
magento/module-catalog *
magento/module-theme *

Requires-dev 2

Package Constraint
magento/magento-coding-standard ^33
roave/security-advisories dev-latest

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.

Compatibility matrix (Magento × PHP)
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. 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.

Static analysis results
Tool Status Findings Summary
PHPCS Fail 25 1 error, 24 warnings (ruleset: Magento2) — 12 auto-fixable with phpcbf
PHPMD Pass 0
Cpd Pass 0
Composer validate Info 5 valid; 5 advisory notes (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.

PHPStan results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 4 4
2.4.8 4 4
2.4.9 4 4

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

Unit tests results by Magento and PHP version
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

Integration tests results by Magento and PHP version
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.

Security results
Tool Status Findings Summary
Composer audit Pass 0
Malware scan Pass 0
License
MIT
Homepage
https://github.com/opengento/magento2-product-breadcrumbs
Authors

More from opengento

View vendor
Make it pay

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.