viraxpress / customerapproval
Customer Approval Extension for Magento2
Package info
github.com/viraxpress/CustomerApproval
Type:magento2-module
pkg:composer/viraxpress/customerapproval
Requires
- php: ~8.1.0||~8.2.0||~8.3.0||~8.4.0
README
Magento 2 module that provides a customer account approval workflow. The extension adds support for pending, approved, and disapproved customer status, configurable approval rules, and email notifications for registration, approval, and rejection.
Features
- Admin approval and disapproval actions for customer accounts
- Bulk approve or disapprove customers from the admin customer grid
- Adds the
is_approvedcustomer attribute with values:pendingapproveddisapproved
- Automatic approval or pending approval for new registrations
- Exclude specific customer groups from approval restrictions
- Auto approve/disapprove based on customer email domains or IP addresses
- Configurable admin notification emails
- Configurable customer notification emails for registration, approval, and disapproval
- Pending and disapproved customers are prevented from logging in with a customizable message
Compatibility
- Magento 2.4.x
Installation
Install from ZIP
- Unzip the module into
app/code/ViraXpress/CustomerApproval - Enable the module:
php bin/magento module:enable ViraXpress_CustomerApproval
- Run setup upgrade:
php bin/magento module:enable ViraXpress_CustomerApproval php bin/magento setup:upgrade php bin/magento setup:di:compile php bin/magento setup:static-content:deploy -f php bin/magento cache:flush
- Flush cache:
php bin/magento cache:flush
Install via Composer
- Add the composer repository that hosts the package.
- Install the module:
composer require viraxpress/customerapproval
- Enable the module:
php bin/magento module:enable ViraXpress_CustomerApproval
- Run setup upgrade:
php bin/magento module:enable ViraXpress_CustomerApproval php bin/magento setup:upgrade php bin/magento setup:di:compile php bin/magento setup:static-content:deploy -f php bin/magento cache:flush
- Flush cache:
php bin/magento cache:flush
Configuration
After installation, configure the extension in the Magento admin under:
Stores > Settings > Configuration > ViraXpress > Customer Account Approval
Available options include:
- Enable Account Approval
- Excluded customer groups
- Automatically approve accounts
- Pending approval message
- Disapproved account message
- Admin email notification settings
- Customer notification settings for registration, approval, and disapproval
- Auto-approved and auto-disapproved IP address lists
- Auto-approved and auto-disapproved email domain lists
Customer Approval Workflow
- When enabled, new customer registrations may be set to
pendingor automaticallyapproved. - Pending customers are blocked from logging in until an admin approves their account.
- Disapproved customers are immediately blocked and shown a configurable rejection message.
- Admins can approve/disapprove customers from the customer edit page and via mass actions in the customer grid.
Notes
- The module adds and manages the
is_approvedcustomer attribute. - Built-in email templates are included for registration, approval, disapproval, and admin notifications.
Support
For support, please contact ViraXpress at https://www.viraxpress.com or refer to the license agreement.
License
This extension is licensed under the ViraXpress license agreement. See https://www.viraxpress.com/license for details.