opengento / module-gdpr

opengento/module-gdpr

Gdpr Compliance Module for Magento 2

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

GDPR Module for Magento 2

Latest Stable Version
License: MIT
Packagist
Packagist
Codacy Badge

This extension fulfill the GDPR requirements for Magento 2.

Setup

Magento 2 Open Source or Commerce edition is required.

Composer installation

Run the following composer command:

composer require opengento/module-gdpr

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

See the screenshots of the module's features.

Users, guest and customer can:

  • Art. 16 GDPR Edit their personal data (native in vanilla)

  • Art. 17 GDPR

    • Customers can use their 'right to be forgotten'. Account deletion and anonymization can be done in 'My Account > Privacy Settings'.
      The password is required to ensure the customer legibility.
      The account will be erased within 1 hour, or as specified in configuration. The customer can undo the action in this time span.
    • Guest users can use their 'right to be forgotten'. Account deletion and anonymization can be done in the order view,
      they must fill the guest form first to show their order.
      The data will be erased within 1 hour, or as specified in the configuration. The guest can undo the action is this time spare.
    • The customers and guests will be erased after a configurable idle time.
    • The sales information are locked within a configurable time. These information are automatically erased after this period.

    As a merchant you can easily manage which type of entity must to be delete or anonymize. In the last case,
    the module allows to define which attribute must to be anonymize, and how it is.

Times are configurable too, you can define the period of cancellation for the erasure,
the idle time for the users before they are erase, and the sales information lifetime.

  • Art. 20 GDPR
    • Customers can export their data in .zip archive containing file, .html (many others are available), with personal data.
      Personal data export can be done in 'My Account > Privacy Settings'.
    • Guest users can export their data in .zip archive containing file, .html (many others are available), with personal data.
      Personal data export can be done in the order view, they must fill the guest form first to show their order.
  • Cookie Policy in a disclosure popup are shown at the first time customer visit.

Details:

  • Erasure: delete or anonymize specific data thanks to configurable settings in admin ui.
  • Configure which order can be erased, regarding their state and life time.
  • Privacy data will be automatically erased after a delay.
  • Sales data are safely keeped till the preservation delay expired.
  • Choose the file name and the format of your choice for the privacy data export.
  • Choose which data is interpreted as privacy data and will be exported.
  • Actions related to the GDPR compliance are reported in the admin ui.
  • Merchants can execute and keep an eye on the performed actions from the admin ui.
  • Choose the CMS static block to show on the storefront by scope and features.
  • Enable or disable features for the storefront.
  • Notify the user when a GDPR action is performed, configure the template and sending settings.
  • Display the cookie disclosure pop-in and edit its content as you want.

Languages:

Open contributions to translations can be done with transifex.

  • bg_BG ; Bulgarian
  • de_DE ; German
  • en_US ; English
  • fr_FR ; French
  • it_IT ; Italian
  • nl_NL ; Dutch
  • pl_PL ; Polish
  • th_TH ; Thai
  • da_DK ; Danish

Many thanks to the translators who contributed directly here or with transifex!

Settings

The configuration for this module is available in 'Stores > Configuration > GDPR Compliance'.

Documentation

The documentation is available here.

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
4.4.3 stable Fail Magento 2.4.7-2.4.9 Details 2025-07-23 14:23:55
5.0.0-beta1 beta Not tested Not yet tested Details 2024-08-28 14:38:34
4.4.2 stable Not tested Not yet tested Details 2024-01-30 13:39:33
4.4.1 stable Not tested Not yet tested Details 2023-03-16 17:14:23
4.4.0 stable Not tested Not yet tested Details 2022-09-05 20:55:55
4.3.0 stable Not tested Not yet tested Details 2022-08-13 21:28:22
4.2.3 stable Not tested Not yet tested Details 2022-06-07 10:21:23
4.2.2 stable Not tested Not yet tested Details 2022-05-16 15:15:06
4.2.1 stable Not tested Not yet tested Details 2022-05-04 20:33:26
4.2.0 stable Not tested Not yet tested Details 2022-04-29 20:07:06
3.0.2 stable Not tested Not yet tested Details 2021-09-26 15:31:31
3.0.1 stable Not tested Not yet tested Details 2021-09-17 09:27:41
4.1.5 stable Not tested Not yet tested Details 2021-09-07 16:30:45
4.1.4 stable Not tested Not yet tested Details 2021-08-22 11:48:23
4.1.3 stable Not tested Not yet tested Details 2021-05-13 20:39:08
4.1.2 stable Not tested Not yet tested Details 2021-05-08 18:22:44
4.1.1 stable Not tested Not yet tested Details 2021-04-27 12:56:24
4.1.0 stable Not tested Not yet tested Details 2021-04-27 09:32:41
4.0.0 stable Not tested Not yet tested Details 2021-02-10 22:16:00
3.0.0 stable Not tested Not yet tested Details 2021-02-10 22:15:34
4.0.0-beta4 beta Not tested Not yet tested Details 2020-12-29 16:03:27
3.0.0-beta5 beta Not tested Not yet tested Details 2020-12-29 16:03:09
3.0.0-beta4 beta Not tested Not yet tested Details 2020-12-26 22:11:29
4.0.0-beta3 beta Not tested Not yet tested Details 2020-12-26 19:13:06
3.0.0-beta.3 beta Not tested Not yet tested Details 2020-12-24 10:29:29
4.0.0-beta2 beta Not tested Not yet tested Details 2020-12-24 10:28:42
4.0.0-beta beta Not tested Not yet tested Details 2020-12-23 13:13:03
4.0.0-alpha alpha Not tested Not yet tested Details 2020-11-21 11:36:40
3.0.0-beta.2 beta Not tested Not yet tested Details 2020-11-04 23:32:02
3.0.0-beta beta Not tested Not yet tested Details 2019-03-22 08:20:30
2.0.0-beta5 beta Not tested Not yet tested Details 2018-09-25 18:39:18
1.0.0-beta5 beta Not tested Not yet tested Details 2018-09-25 18:37:16
1.0.0-beta4 beta Not tested Not yet tested Details 2018-07-31 14:47:30
2.0.0-beta4 beta Not tested Not yet tested Details 2018-07-31 14:47:02
1.0.0-beta3 beta Not tested Not yet tested Details 2018-07-31 13:29:45
2.0.0-beta3 beta Not tested Not yet tested Details 2018-07-31 13:29:04
1.0.0-beta2 beta Not tested Not yet tested Details 2018-07-31 09:55:40
2.0.0-beta2 beta Not tested Not yet tested Details 2018-07-31 09:54:52
2.0.0-beta beta Not tested Not yet tested Details 2018-07-20 08:27:57
1.0.0-beta beta Not tested Not yet tested Details 2018-07-20 08:27:46
2.0.0-alpha2 alpha Not tested Not yet tested Details 2018-07-02 19:22:56
1.0.0-alpha2 alpha Not tested Not yet tested Details 2018-07-02 19:18:25
1.0.0-alpha alpha Not tested Not yet tested Details 2018-06-29 14:14:41
2.0.0-alpha alpha Not tested Not yet tested Details 2018-06-29 14:11:24

Requires 15

Package Constraint
php ^7.4||^8.0
ext-zip *
tecnickcom/tcpdf ^6.4
magento/framework ^103.0
magento/module-backend ^101.0||^102.0
magento/module-config ^101.1
magento/module-cookie ^100.0
magento/module-customer ^102.0||^103.0
magento/module-quote ^101.1
magento/module-sales ^102.0||^103.0
magento/module-review ^100.3
magento/module-email ^101.0
magento/module-newsletter ^100.4
magento/module-cms ^103.0||^104.0
magento/module-theme ^101.0

Requires-dev 3

Package Constraint
magento/magento-coding-standard ^5
magento/marketplace-eqp ^4.0
roave/security-advisories dev-master

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 523 158 errors, 365 warnings (ruleset: Magento2) — 6 auto-fixable with phpcbf
PHPMD Warning 2 2 rule violations (MissingImport:2)
Cpd Warning 3 3 duplicated chunks spanning 99 total lines (min-lines=5, min-tokens=70)
Composer validate Pass 0

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.

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

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 N/A 0 no resolvable dependency tree to audit — Your requirements could not be resolved to an installable set of packages. Problem 1
Malware scan Pass 0
License
MIT
Homepage
https://github.com/opengento/magento2-gdpr
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.