About this plugin
This plugin allows you to restrict the usage of WooCommerce coupons based on user roles, including guest users.
You can specify which roles (including guests) are allowed or excluded from using a coupon, providing more control over your discount strategies.
Features
- Restrict coupon usage based on user roles.
- Option to specify both allowed and excluded roles.
- Support for guest users with a “Customer Is A Guest” pseudo-role.
- Customize the error message via a filter.
Filters
runthings_wc_coupons_role_restrict_error_message
This filter allows customization of the error message shown when a coupon is not valid for the user’s account type.
For detailed documentation and advanced examples, see the full documentation on GitHub.
Parameters:
- $message ( string ): The default error message, e.g., "Sorry, this coupon is not valid for your account type.".
- $context ( array ): Additional context for the error, including the coupon, user roles, and guest status.
$context object format:
The $context array contains the following keys:
– coupon ( WC_Coupon ): The coupon object being validated.
– is_guest ( bool ): Whether the current user is a guest (not logged in).
– user ( WP_User ): The current user object. For guests, this will be an empty user object.
– allowed_roles ( array ): Roles explicitly allowed to use the coupon, in the format [role_id => role_name].
– excluded_roles ( array ): Roles explicitly excluded from using the coupon, in the format [role_id => role_name].
– effective_allowed_roles ( array ): The final calculated roles allowed to use the coupon, after considering exclusions, in the format [role_id => role_name]. This is the set of roles that can use the coupon.
License
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
html.
0)
0)