Skip to content

Commit 9de423c

Browse files
Changes from Dhub (#66)
--------- Co-authored-by: dhub-sync[bot] <145223974+dhub-sync[bot]@users.noreply.github.com>
1 parent a41a2ad commit 9de423c

16 files changed

Lines changed: 114 additions & 83 deletions

website/docs-v6/apps-and-extensions/apps/app_calculatorsortbyprice.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Once you have installed the App, you will need to enable it. There are **two** w
3535

3636
**Option A:** Go to the **J2Commerce** icon at the top right corner **-> Apps**
3737

38-
**Option B:** Go to **Components** on the left sidebar **-> J2Commerce -> Dashboard -> Apps**
38+
**Option B:** Go to **Components** on the left sidebar **-> J2Commerce -> Apps**
3939

4040
![shipping method](/img/accordions-app.webp)
4141

website/docs-v6/apps-and-extensions/apps/app_changepasswords.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Once you have installed the App, you will need to enable it. There are **two** w
4343

4444
**Option A:** Go to the **J2Commerce** icon at the top right corner **-> Apps**
4545

46-
**Option B:** Go to **Components** on the left sidebar **-> J2Commerce -> Dashboard -> Apps**
46+
**Option B:** Go to **Components** on the left sidebar **-> J2Commerce -> Apps**
4747

4848
![shipping method](/img/accordions-app.webp)
4949

@@ -69,14 +69,12 @@ After adjusting settings, click **Save** or **Save & Close**.
6969

7070
When a logged-in customer visits their **My Account** page on the frontend, a **Change Password** tab appears in the profile navigation alongside any other profile tabs.
7171

72-
<!-- SCREENSHOT: Frontend My Profile page showing Change Password tab in the tab navigation -->
73-
7472
Clicking the tab reveals a simple form with two fields:
7573

7674
- **New Password** — the customer's desired new password
7775
- **Confirm Password** — must match the New Password field exactly
7876

79-
<!-- SCREENSHOT: Change Password tab content showing New Password, Confirm Password fields and the Change Password button -->
77+
![](/img/password-reset.webp)
8078

8179
When the customer clicks **Change Password**:
8280

website/docs-v6/apps-and-extensions/apps/custom-accordions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Once you have installed the App, you will need to enable it. There are **two** w
3232

3333
**Option A:** Go to the **J2Commerce** icon at the top right corner **-> Apps**
3434

35-
**Option B:** Go to **Components** on the left sidebar **-> J2Commerce -> Dashboard -> Apps**
35+
**Option B:** Go to **Components** on the left sidebar **-> J2Commerce -> Apps**
3636

3737
![shipping method](/img/accordions-app.webp)
3838

website/docs-v6/apps-and-extensions/apps/j2commerce_advancedcart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Once you have installed the plugin, you will need to enable it. There are **two*
4646

4747
**Option A:** Go to the **J2Commerce** icon at the top right corner **-> Apps**
4848

49-
**Option B:** Go to **Components** on the left sidebar **-> J2Commerce -> Dashboard -> Apps**
49+
**Option B:** Go to **Components** on the left sidebar **-> J2Commerce -> Apps**
5050

5151
![shipping method](/img/accordions-app.webp)
5252

Lines changed: 107 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,40 @@
1-
---
2-
title: "Add to User Group"
3-
sidebar_label: "Add to User Group"
4-
sidebar_position: 10
5-
description: "Automatically add customers to Joomla user groups when they purchase products — useful for membership sites, wholesale access, and ACL-controlled content."
6-
---
7-
81
# Add to User Group
92

103
The Add to User Group app plugin automatically adds a customer to one or more Joomla user groups as soon as their order reaches a status you choose. You can set groups at the individual product level, at the Joomla content category level, or both. Category settings always take priority over product settings.
114

125
Common uses include granting access to a members-only content area after purchase, upgrading a customer to a wholesale or dealer group, and controlling what ACL-restricted pages a buyer can see based on what they have bought.
136

14-
## Installation
15-
16-
This plugin is a separate add-on available from the [J2Commerce Extensions Store](https://www.j2commerce.com). It is not included with the core J2Commerce 6 component.
17-
18-
1. Purchase and download the `app_usergroup.zip` package from the J2Commerce website.
19-
2. Go to **System** -> **Install** -> **Extensions**.
20-
3. Upload the `app_usergroup.zip` package file.
21-
4. The plugin installs and enables automatically.
7+
## Requirements
228

23-
After installation, go to **J2Commerce** -> **Apps** to configure it.
9+
- with PHP 8.3.0 +
10+
- Joomla! 6.x
11+
- J2Commerce 6.x
2412

2513
## Prerequisites
2614

27-
- J2Commerce 6 installed and configured.
15+
- J2Commerce 6 is installed and configured.
2816
- At least one product created.
29-
- The Joomla user groups you want to assign must already exist. Create them under **System** -> **User Groups** before proceeding.
17+
- The Joomla user groups you want to assign must already exist. Create them under **Users ->** **Groups** before proceeding.
18+
19+
![](/img/user-create.webp)
20+
21+
## Purchase and Download
22+
23+
**Step 1:** Go to our [**J2Commerce** website](https://www.j2commerce.com/) **->** **Apps**
24+
25+
**Step 2:** Locate the `app_usergroup.zip` App **->** click **View Details** **->** **Add to cart -> Checkout**.&#x20;
26+
27+
**Step 3:** Go to your **My Downloads** under your profile button at the top right corner and search for the app. Click **Available Versions -> View Files -> Download Now**
28+
29+
## Install the App
30+
31+
You can install the App using the Joomla installer. The following steps help you with a successful installation.
32+
33+
In the Joomla admin, go to **System -> Install -> Extensions**
34+
35+
Upload the `app_usergroup.zip` file or use the Install from URL option.
36+
37+
![Install extensions](<../../../assets/app install1 (1) (1).webp>)
3038

3139
## Quick Setup Overview
3240

@@ -35,65 +43,97 @@ After installation, go to **J2Commerce** -> **Apps** to configure it.
3543
3. Assign user groups to each product, or to a content category.
3644
4. Test by placing an order and confirming the customer lands in the right group.
3745

38-
---
46+
***
47+
48+
## Enable the App
49+
50+
Once you have installed the App, you will need to enable it. There are **three** ways you can access the extension.&#x20;
51+
52+
**Option A:** Go to the **J2Commerce** icon at the top right corner **-> Apps**
53+
54+
**Option B:** Go to **Components** on the left sidebar **-> J2Commerce -> Apps**
55+
56+
**Option C:** Go to **System** **-> Manage -> Plugins**.
57+
58+
![](/img/user-enable1.webp)
59+
60+
Search for **Add to User Group**.
3961

40-
## Step 1: Enable and Configure the Plugin
62+
Look for **Custom Accordions**, click the **X,** and it will turn into a green checkmark. It is now enabled and ready for setup.
4163

42-
1. Go to **System** -> **Manage** -> **Plugins**.
43-
2. Search for **Add to User Group**.
44-
3. Click the plugin name to open its settings.
64+
![](/img/user-enable.webp)
4565

46-
<!-- SCREENSHOT: Plugin Manager search results showing "Add to User Group" plugin with status toggle -->
66+
## Configure the App
4767

4868
### Plugin Settings
4969

50-
| Setting | Description | Default |
51-
|---------|-------------|---------|
52-
| **Order Status** | The order statuses that trigger user group assignment. When an order reaches any of the selected statuses, the customer is added to the configured groups. Select one or more statuses. | Confirmed (status ID 1) |
53-
| **Debug Mode** | When enabled, the plugin writes detailed log entries to a file named `app_usergroup.php` in the Joomla logs directory. Turn this on when troubleshooting; disable it in production. | No |
70+
Click the plugin name to open its settings.
5471

55-
<!-- SCREENSHOT: Plugin settings form showing Order Status multi-select and Debug Mode toggle -->
72+
![](/img/user-config.webp)
5673

57-
**Choosing the right order status:**
58-
Most stores use **Confirmed** or **Processing** as the trigger. Using **Pending** may add customers to groups before payment is verified. Using a completed/shipped status means customers wait longer for access. Choose the status that matches your fulfillment workflow.
74+
**Order Status:** The order statuses that trigger user group assignment. When an order reaches any of the selected statuses, the customer is added to the configured groups. Select one or more statuses.
5975

60-
4. Click **Save** when finished.
76+
**Debug Mode:** When enabled, the plugin writes detailed log entries to a file named `app_usergroup.php` in the Joomla logs directory. Turn this on when troubleshooting; disable it in production.
6177

62-
---
78+
:::tip
6379

64-
## Step 2: Assign User Groups to Products
80+
**Tip**: **Choosing the right order status:** Most stores use **Confirmed** or **Processing** as the trigger. Using **Pending** may add customers to groups before payment is verified. Using a completed/shipped status means customers wait longer for access. Choose the status that matches your fulfillment workflow.
81+
82+
:::
83+
84+
## Assign User Groups to Products
6585

6686
For each product that should trigger a group assignment, open the product and set the groups in the plugin's tab.
6787

68-
1. Go to **J2Commerce** -> **Catalog** -> **Products**.
69-
2. Click the product name to edit it.
70-
3. Scroll down to find the **Add to User Group** tab or panel.
71-
4. In the **User Group List** field, select one or more groups from the dropdown.
88+
There are **three** ways you can access the products.&#x20;
89+
90+
**Option A:** Go to the **J2Commerce** icon at the top right corner **-> Catalog -> Products**
91+
92+
**Option B:** Go to **Components** on the left sidebar **-> J2Commerce -> Products**
93+
94+
**Option C:** Go to **Content -> Categories ->** Find the **category** and then click inside the **published**/article section
95+
96+
![](/img/accordions-products.webp)
97+
98+
- Click on the product name to edit it.
99+
100+
Go to the **J2Commerce** tab **-> Apps** tab
101+
102+
- Scroll down to find the **Add to User Group** app.
103+
104+
![](/img/user-product.webp)
72105

73-
<!-- SCREENSHOT: Product edit form showing the "Add to User Group" panel with the User Group List multi-select dropdown -->
106+
- In the **User Group List** field, select one or more groups from the dropdown.
74107

75-
5. Click **Save** or **Save & Close**.
108+
![](/img/user-product1.webp)
76109

77-
Repeat this for every product that should grant group membership on purchase. Products with no groups selected are simply ignored by this plugin.
110+
:::info
78111

79-
---
112+
**Note**: Repeat this for every product that should grant group membership on purchase. Products with no groups selected are simply ignored by this plugin.
80113

81-
## Step 3: Assign User Groups at the Category Level (Optional)
114+
:::
115+
116+
## Assign User Groups at the Category Level (Optional)
82117

83118
If you have a whole category of products that should all grant the same group, you can set the groups once on the category instead of repeating the setting on each product. When category groups are present, they take over completely — the product-level setting is ignored for that item.
84119

85-
1. Go to **Content** -> **Categories**.
86-
2. Click the category that contains your products.
87-
3. Find the **Add To User Groups** tab in the category editor.
88-
4. In the **User Group List** field, select one or more groups.
120+
Go to **Content -> Categories**
121+
122+
![](/img/user-categories.webp)
123+
124+
Click the category that contains your products.
125+
126+
Find the **Add To User Groups** tab in the category editor.
127+
128+
In the **User Group List** field, select one or more groups.
89129

90-
<!-- SCREENSHOT: Joomla category editor showing the "Add To User Groups" tab with the group selector -->
130+
![](/img/user-categories1.webp)
91131

92-
5. Click **Save & Close**.
132+
:::info
93133

94134
**Priority rule:** If a product belongs to a category that has groups configured, those category groups are used and any product-level groups are ignored. If the category has no groups set, the product-level groups are used as the fallback.
95135

96-
---
136+
:::
97137

98138
## How It Works
99139

@@ -108,62 +148,55 @@ When an order's status changes to one of the statuses you configured:
108148

109149
The plugin handles duplicate group assignments gracefully — if the customer is already in a group, nothing breaks.
110150

111-
Guest customers (users who checked out without a Joomla account) are skipped because there is no Joomla user ID to assign a group to.
151+
:::info
112152

113-
---
153+
**Note:** Guest customers (users who checked out without a Joomla account) are skipped because there is no Joomla user ID to assign to a group.
154+
155+
:::
114156

115157
## Use Case Examples
116158

117159
### Members-Only Digital Access
118160

119-
You sell a digital subscription product. Your Joomla site has a **Members** group that can access restricted articles.
161+
You sell a digital subscription product. Your Joomla site has a **Members-Only** group that can access restricted articles.
120162

121-
- Create the **Members** user group under **System** -> **User Groups**.
163+
- Create the **Members-Only** user group under **Users->** **Groups**.
122164
- Set appropriate **View Level** restrictions on your members-only articles.
123-
- On the subscription product, select **Members** in the **User Group List**.
165+
- On the subscription product, select **Members-Only** in the **User Group List**.
124166
- Set the plugin's **Order Status** to **Confirmed**.
125167

126-
When a customer's order is confirmed, they are immediately added to the **Members** group and can view the restricted content on their next page load.
168+
When a customer's order is confirmed, they are immediately added to the **Members-Only** group and can view the restricted content on their next page load.
127169

128170
### Wholesale Pricing by Category
129171

130172
You have a **Wholesale Products** category. Any customer who buys from it should be upgraded to your **Wholesale** group.
131173

132174
- Create the **Wholesale** group in Joomla.
133-
- Open the **Wholesale Products** category in **Content** -> **Categories**.
175+
- Open the **Wholesale Products** category in **Content -> Categories**.
134176
- Set **Wholesale** in the **Add To User Groups** tab.
135177

136178
All products in that category will now trigger the group assignment on purchase — no need to configure each product individually.
137179

138-
---
139-
140180
## Troubleshooting
141181

142182
### The customer was not added to the group after purchase
143183

144-
**Check 1 — Order status match.** Open the order and note the current status. Go back to the plugin settings and confirm that status is selected in **Order Status**. If the order is **Pending** but you only have **Confirmed** selected, no assignment will happen until the order is confirmed.
145-
146-
**Check 2 — User group is set on the product or category.** Edit the product and check the **Add to User Group** panel. Make sure at least one group is selected. If the product belongs to a category with groups set, the category groups override the product — verify the category setting too.
184+
- **Check 1 — Order status match.** Open the order and note the current status. Go back to the plugin settings and confirm that status is selected in **Order Status**. If the order is **Pending** but you have only **Confirmed** selected, no assignment will happen until the order is confirmed.
147185

148-
**Check 3Guest checkout.** If the customer placed the order as a guest (no Joomla account), the plugin cannot assign a group. The plugin only works for registered users with a valid Joomla user ID.
186+
- **Check 2User group is set on the product or category.** Edit the product and check the **Add to User Group** panel. Make sure at least one group is selected. If the product belongs to a category with groups set, the category groups override the product — verify the category setting too.
149187

150-
**Check 4Enable debug mode.** In the plugin settings, turn on **Debug Mode** and reproduce the issue by manually changing the order status. Then open the file `[joomla-root]/logs/app_usergroup.php` in a text editor and look for log entries related to that order.
188+
- **Check 3Guest checkout.** If the customer placed the order as a guest (no Joomla account), the plugin cannot assign a group. The plugin only works for registered users with a valid Joomla user ID.
151189

152-
---
190+
- **Check 4 — Enable debug mode.** In the plugin settings, turn on **Debug Mode** and reproduce the issue by manually changing the order status. Then open the file `[joomla-root]/logs/app_usergroup.php` in a text editor and look for log entries related to that order.
153191

154192
### Debug Mode shows "Status X not in configured statuses"
155193

156-
The order status ID does not match any of the statuses you selected in the plugin. Open the plugin settings, expand **Order Status**, and add the status ID shown in the log entry.
194+
**Cause:** The order status ID does not match any of the statuses you selected in the plugin.&#x20;
157195

158-
---
196+
**Solution:** Open the plugin settings, expand **Order Status**, and add the status ID shown in the log entry.
159197

160198
### A product in the category is not triggering the category groups
161199

162-
The category-level setting only applies to products sourced from Joomla content articles (the standard J2Commerce product type linked to `com_content`). Confirm the product was created through the standard J2Commerce workflow and is linked to a content article in the correct category.
163-
164-
---
165-
166-
## Related Topics
200+
**Cause:** The category-level setting only applies to products sourced from Joomla content articles (the standard J2Commerce product type linked to `com_content`).&#x20;
167201

168-
- [Order Statuses](../../configuration/setup/orderstatuses.md)
169-
- [Apps Overview](../index.md)
202+
**Solution:** Confirm the product was created through the standard J2Commerce workflow and is linked to a content article in the correct category.

website/docs-v6/catalog/product-types/app_flexivariable.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,11 +141,11 @@ Every product needs a Joomla article. The article title becomes the product name
141141

142142
There are multiple ways to navigate to the location for creating a new product.
143143

144-
**Option a:** Go to **Content** **-> Articles -> New**.
144+
**Option A:** Go to **Content** **-> Articles -> New**.
145145

146146
![](/img/simple.webp)
147147

148-
**Option b:** Or go to **J2Commerce -> Catalog -> Product -> New**
148+
**Option B:** Or go to **J2Commerce -> Catalog -> Product -> New**
149149

150150
![](/img/simple-product1.webp)
151151

19.7 KB
Loading
63.2 KB
Loading
40.6 KB
Loading
44.8 KB
Loading

0 commit comments

Comments
 (0)