QC: {IF-CUSTOMER-IN-GROUP-BEGIN}

The {IF-CUSTOMER-IN-GROUP-BEGIN} QuickCode Tag may be used with the {IF-CUSTOMER-IN-GROUP-END} QuickCode Tag to create a block of content that will only be shown if the logged in customer is assigned to one or more specified customer groups.

Customer groups are created in the Customer Group Editor and the rule settings determine which customers will be assigned to the customer group.

The visitor must be logged in to his or her customer account in order for the system to accurately check if he or she is in the specified customer group(s). If the visitor is not currently logged in to his or her customer account, then the shopping cart cannot know which customer to look for in the specified customer group(s), and so the result is the same as if the customer is not assigned to the specified customer group(s).

Requirements / Prerequisites

The {IF-CUSTOMER-IN-GROUP-BEGIN} QuickCode Tag must be used in combination with the {IF-CUSTOMER-IN-GROUP-END} QuickCode Tag. The {ELSE} QuickCode Tag may optionally be inserted between {IF-CUSTOMER-IN-GROUP-BEGIN} and {IF-CUSTOMER-IN-GROUP-END}.

{IF-CUSTOMER-IN-GROUP-BEGIN} and {IF-CUSTOMER-IN-GROUP-END} are compatible with any storefront template.

Content between {IF-CUSTOMER-IN-GROUP-BEGIN} and {IF-CUSTOMER-IN-GROUP-END} will be shown if the customer is in the customer group(s) specified through the parameters of {IF-CUSTOMER-IN-GROUP-BEGIN}.

If {ELSE} is inserted between {IF-CUSTOMER-IN-GROUP-BEGIN} and {IF-CUSTOMER-IN-GROUP-END}, then content between {IF-CUSTOMER-IN-GROUP-BEGIN} and {ELSE} will be shown if the customer is in the customer group(s) specified through the parameters of {IF-CUSTOMER-IN-GROUP-BEGIN}. Any alternate content between {ELSE} and {IF-CUSTOMER-IN-GROUP-END} will be shown if the customer is not in the customer group(s) specified through the parameters of {IF-CUSTOMER-IN-GROUP-BEGIN}.

Parameters

The {IF-CUSTOMER-IN-GROUP-BEGIN} QuickCode Tag has one required parameter and one optional parameter, which are explained in the Customization section below.

Example of Use

1. Create customer group SID 1 with the following rule settings:

Example
Rule Type: Customer Account
Rule Details: Reward Points / is greater than / 100

2. Create customer group SID 2 with the following rule settings:

Example
Rule Type: Order History
Rule Details: Vendor Name / is / Flower Garden

3. Create customer group SID 3 with the following rule settings:

Example
Rule Type: Subscriptions
Rule Details: Product SID / is / 456

4. Add the following to any storefront template:

Example
{IF-CUSTOMER-IN-GROUP-BEGIN:1,2,3:all}
Hello, {CUSTOMER-BILL-FIRST-NAME}! As a current subscriber to our "Flower of the Month" club, you may be interested to know that Flower Garden has a new batch of Vanda Orchids ready for shipment now! This beautiful flower was the February 2013 Flower of the Month and is now available for direct purchase for the first time.
{ELSE}
Direct from Flower Garden, we have a batch of gorgeous Vanda Orchids ready to ship! This beautiful flower was the February 2013 Flower of the Month, and is now available for direct purchase for the first time.
{IF-CUSTOMER-IN-GROUP-END}

5. When the customer Florence is logged in to her customer account, since she has over 100 reward points accumulated, and has previously purchased a product associated with the "Flower Garden" vendor, and has an active subscription to product SID 456, the corresponding storefront page will display the following:

Example
Hello, Florence! As a current subscriber to our "Flower of the Month" club, you may be interested to know that Flower Garden has a new batch of Vanda Orchids ready for shipment now! This beautiful flower was the February 2013 Flower of the Month and is now available for direct purchase for the first time.

6. If the customer Florence is not logged in to her customer account, the same storefront page would display:

Example
Direct from Flower Garden, we have a batch of gorgeous Vanda Orchids ready to ship! This beautiful flower was the February 2013 Flower of the Month, and is now available for direct purchase for the first time.

Customization

Parameters

The {IF-CUSTOMER-IN-GROUP-BEGIN} QuickCode Tag has one required parameter and one optional parameter: {IF-CUSTOMER-IN-GROUP-BEGIN:X:any|all}

X [Required] The SID number(s) of the customer group(s). A single customer group SID number may be entered, or a comma-separated list of customer group SID numbers may be entered instead.
any|all [Optional] This parameter accepts the value any or the value all, and is used to indicate whether the customer must be in any of the specified customer groups, or in all of the specified customer groups. If this parameter is omitted, the system will check if the customer is in any of the specified customer groups.

Source Code

Source Code Updated:

When a web page using a template that contains this QuickCode Tag is viewed in the storefront, the {IF-CUSTOMER-IN-GROUP-BEGIN} QuickCode Tag is changed into the source code below prior to the web page being displayed.