opengento / module-gdpr
opengento/module-gdpr
Gdpr Compliance Module for Magento 2
GDPR Module for Magento 2
This extension allows customers to delete, anonymize, and export their personal data.
Setup
Magento 2 Open Source or Commerce edition is required.
The Version 3.x is compliant with Magento 2.3.x.
The Version 2.x is compliant with Magento 2.2.x.
The Version 1.x is compliant with Magento 2.1.x.
This module does not support Magento 2.0.x, as this version is not anymore maintained.
Get the package
Zip Package:
Unzip the package in app/code/Opengento/Gdpr.
Composer Package:
composer require opengento/module-gdpr
Install the module
Then, 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.
Usage
- Art. 17 GDPR
- Account deletion and anonymization can be done in 'My Account > Privacy Settings'.
- Customers can use their 'right to be forgotten'. 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.
- Art. 20 GDPR
- Personal data export can be done in 'My Account > Privacy Settings'.
- Customers can export their data in
.ziparchive containing file,.html(many others are available), with personal data.
- Cookie Policy in a disclosure popup are shown at the first time customer visit.
Settings
The configuration for this module is located in 'Stores > Configuration > Customers > Customer Configuration > Privacy (GDPR)'.
The settings are divided as following:
- General Settings
- Enable the module
- GDPR Information CMS Page
- GDPR Information CMS Block
- Erasure Settings
- Enable the feature
- Erasure Strategy (Anonymize or Delete)
- Erasure Time Laps
- Cron Scheduler
- Right to Erasure Information CMS Block
- Anonymization Information CMS Block
- Remove Customer if no Orders
- Apply Deletion Strategy to specific components
- Export Settings
- Enable the feature
- Export Personal Data Information CMS Block
- Export Renderer option
- Customer Attributes to export
- Customer Address Attributes to export
- Cookie Settings
- Enable the cookie disclosure
- Cookie Policy Information CMS Block
Developers
The following documentation explains how to add your own processors to the workflow.
Extends Export
In order to export your custom component, you must create a new processor.
To create a new processor, you must implement the following interface: \Opengento\Gdpr\Service\Export\ProcessorInterface.
Then, register your processor to the following pool \Opengento\Gdpr\Service\Export\ProcessorPool, as described:
<type name="Opengento\Gdpr\Service\Export\ProcessorPool">
<arguments>
<argument name="array" xsi:type="array">
<item name="my_component" xsi:type="string">\Vendor\Module\ExportProcessor</item>
</argument>
</arguments>
</type>
You can also create your custom export renderer to make it as be like you want to be.
To achieve this, you must implement the following interface: \Opengento\Gdpr\Service\Export\RendererInterface
Then, register your renderer to the following pool \Opengento\Gdpr\Service\Export\RendererPool, as described:
<type name="Opengento\Gdpr\Service\Export\RendererPool">
<arguments>
<argument name="array" xsi:type="array">
<item name="my_renderer" xsi:type="string">\Vendor\Module\ExportRenderer</item>
</argument>
</arguments>
</type>
Extends Deletion
In order to delete your custom component, you must create a new processor.
To create a new processor, you must implement the following interface: \Opengento\Gdpr\Service\Delete\ProcessorInterface.
Then, register your processor to the following pool \Opengento\Gdpr\Service\Delete\ProcessorPool, as described:
<type name="Opengento\Gdpr\Service\Delete\ProcessorPool">
<arguments>
<argument name="array" xsi:type="array">
<item name="my_component" xsi:type="string">\Vendor\Module\DeleteProcessor</item>
</argument>
</arguments>
</type>
Extends Anonymization
In order to anonymize your custom component, you must create a new processor.
To create a new processor, you must implement the following interface: \Opengento\Gdpr\Service\Anonymize\ProcessorInterface.
Then, register your processor to the following pool \Opengento\Gdpr\Service\Anonymize\ProcessorPool, as described:
<type name="Opengento\Gdpr\Service\Anonymize\ProcessorPool">
<arguments>
<argument name="array" xsi:type="array">
<item name="my_component" xsi:type="string">\Vendor\Module\AnonymizeProcessor</item>
</argument>
</arguments>
</type>
Erasure Strategy
This module allows you to define the strategy to apply for the different processors.
You can configure it thanks to the admin system configuration, but you can also cheat and
define the strategy to apply for them via the etc/di.xml file. Be careful, the settings from the configuration
are always checked in top priority. To make it via the code, add your preferences as following:
<type name="Opengento\Gdpr\Model\Config\ErasureComponentStrategy">
<arguments>
<argument name="componentsStrategies" xsi:type="array">
<item name="component_name_1" xsi:type="const">Opengento\Gdpr\Service\ErasureStrategy::STRATEGY_ANONYMIZE</item>
<item name="component_name_2" xsi:type="const">Opengento\Gdpr\Service\ErasureStrategy::STRATEGY_DELETE</item>
<item name="component_name_3" xsi:type="string">custom_strategy_code</item>
</argument>
</arguments>
</type>
Warning, if you want to implement your own strategy type, you must create your own strategy class object, but you will be able to use the Opengento\Gdpr\Model\Config\ErasureComponentStrategy to serve your components by strategy.
Do not forget to use the right services managers, but you are free to use yours:
Opengento\Gdpr\Service\AnonymizeManagementOpengento\Gdpr\Service\DeleteManagement
Support
Raise a new request to the issue tracker.
Please provide your Magento 2 version and the module version. Explain how to reproduce your issue and what's expected.
Authors
- Initial Inspiration -
Cookie PopUpsources - flurrybox - Opengento Community - Lead - They're awesome!
- Contributors - Contributor - Many thanks!
Similar Magento 2 GDPR Module
- https://github.com/AdFabConnect/magento2gdpr
- https://github.com/mageplaza/magento-2-gdpr
- https://github.com/staempfli/magento2-module-gdpr
- https://github.com/flurrybox/enhanced-privacy
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.
| Version | Stability | QA Status | Released |
|---|---|---|---|
| 4.4.3 | stable | Fail | 2025-07-23 14:23:55 |
| 5.0.0-beta1 | beta | Not tested | 2024-08-28 14:38:34 |
| 4.4.2 | stable | Not tested | 2024-01-30 13:39:33 |
| 4.4.1 | stable | Not tested | 2023-03-16 17:14:23 |
| 4.4.0 | stable | Not tested | 2022-09-05 20:55:55 |
| 4.3.0 | stable | Not tested | 2022-08-13 21:28:22 |
| 4.2.3 | stable | Not tested | 2022-06-07 10:21:23 |
| 4.2.2 | stable | Not tested | 2022-05-16 15:15:06 |
| 4.2.1 | stable | Not tested | 2022-05-04 20:33:26 |
| 4.2.0 | stable | Not tested | 2022-04-29 20:07:06 |
| 3.0.2 | stable | Not tested | 2021-09-26 15:31:31 |
| 3.0.1 | stable | Not tested | 2021-09-17 09:27:41 |
| 4.1.5 | stable | Not tested | 2021-09-07 16:30:45 |
| 4.1.4 | stable | Not tested | 2021-08-22 11:48:23 |
| 4.1.3 | stable | Not tested | 2021-05-13 20:39:08 |
| 4.1.2 | stable | Not tested | 2021-05-08 18:22:44 |
| 4.1.1 | stable | Not tested | 2021-04-27 12:56:24 |
| 4.1.0 | stable | Not tested | 2021-04-27 09:32:41 |
| 4.0.0 | stable | Not tested | 2021-02-10 22:16:00 |
| 3.0.0 | stable | Not tested | 2021-02-10 22:15:34 |
| 4.0.0-beta4 | beta | Not tested | 2020-12-29 16:03:27 |
| 3.0.0-beta5 | beta | Not tested | 2020-12-29 16:03:09 |
| 3.0.0-beta4 | beta | Not tested | 2020-12-26 22:11:29 |
| 4.0.0-beta3 | beta | Not tested | 2020-12-26 19:13:06 |
| 3.0.0-beta.3 | beta | Not tested | 2020-12-24 10:29:29 |
| 4.0.0-beta2 | beta | Not tested | 2020-12-24 10:28:42 |
| 4.0.0-beta | beta | Not tested | 2020-12-23 13:13:03 |
| 4.0.0-alpha | alpha | Not tested | 2020-11-21 11:36:40 |
| 3.0.0-beta.2 | beta | Not tested | 2020-11-04 23:32:02 |
| 3.0.0-beta | beta | Not tested | 2019-03-22 08:20:30 |
| 2.0.0-beta5 | beta | Not tested | 2018-09-25 18:39:18 |
| 1.0.0-beta5 | beta | Not tested | 2018-09-25 18:37:16 |
| 1.0.0-beta4 | beta | Not tested | 2018-07-31 14:47:30 |
| 2.0.0-beta4 | beta | Not tested | 2018-07-31 14:47:02 |
| 1.0.0-beta3 | beta | Not tested | 2018-07-31 13:29:45 |
| 2.0.0-beta3 | beta | Not tested | 2018-07-31 13:29:04 |
| 1.0.0-beta2 | beta | Not tested | 2018-07-31 09:55:40 |
| 2.0.0-beta2 | beta | Not tested | 2018-07-31 09:54:52 |
| 2.0.0-beta | beta | Not tested | 2018-07-20 08:27:57 |
| 1.0.0-beta | beta | Not tested | 2018-07-20 08:27:46 |
| 2.0.0-alpha2 | alpha | Not tested | 2018-07-02 19:22:56 |
| 1.0.0-alpha2 | alpha | Not tested | 2018-07-02 19:18:25 |
| 1.0.0-alpha | alpha | Not tested | 2018-06-29 14:14:41 |
| 2.0.0-alpha | alpha | Not tested | 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 |
No QA results yet
QA pipelines haven't run for this version. Status appears here once the vendor publishes a tagged release that gets ingested.
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.