WooCommerce Setup

This document provides setup instructions and a description for the extension Ultimate Member - WooCommerce. This extension integrates the popular e-commerce plugin WooCommerce with the Ultimate Member plugin.

Notice: Support for WooCommerce's High-Performance Order Storage (HPOS) Update. This is to inform you that our plugin supports the recent announcement made by WooCommerce regarding the introduction of High-Performance Order Storage (HPOS) on October 10, 2023. This upgrade is designed to enhance your overall shopping experience by providing faster checkout and more efficient order processing.

Extension settings
Product settings
- Simple product settings
- Subscription product settings
Profile Menu settings
- Profile tabs
User Role settings
- Account tabs

Extension settings #

When the extension is activated, it adds the Woocommerce tab to the page wp-admin > Ultimate Member > Settings > Extension. In this tab you should see the following settings:

Ignore the roles update, if the user has these roles on complete/processing or refund payment - Only applicable if you assigned a role when an order is completed/processing or refunded.
Assign this role to users when an order is completed/processing * - Automatically assign the user this role when an order's payment is completed.
- Upgrade user role when payment is on-hold before complete or processing status - Optional. Assign a role after checkout before an order's payment is completed.
Assign this role to users when an order is refunded * - Automatically assign the user this role when an order is refunded.
Remove previous roles when change role on complete/processing or refund payment - Remove all previously assigned roles if "Yes".
Warning: Do not remove previous roles if there is no role assigned when an order is completed/processing or refunded. We recommend disabling this feature if you sell subscriptions. The roles assignment logic for subscription uses another algorithm to remove previous roles.
Hide billing tab from members in account page - Enable this option If you do not want to show the billing tab from members in account page. Can be overridden by user role setting.
Hide shipping tab from members in account page - Enable this option If you do not want to show the shipping tab from members in account page. Can be overridden by user role setting.
Show order actions - Show Actions column in the Orders table.
Hide "Add to cart" button - Enable this option If you do not want to show the "Add to cart" button for specific user roles or not logged in users.
- Hide "Add to cart" button for - Optional. Selects users for whom the "Add to cart" button is hidden.
- Hide "Add to cart" button for selected user roles - Optional. Selects user roles for whom the "Add to cart" button is hidden.
Disable subscriptions roles switcher - Optional. Disable the "WooCommerce Subscriptions" role switcher to avoid conflicts.

Note: Read the article Roles Assignment Logic for details.

Image - Settings on wp-admin > Ultimate Member > Settings > Extensions > Woocommerce

Product settings #

The extension allows you to assign a role to a user upon purchase of a specific WooCommerce product. To do this you should go to the WooCommerce "Edit product" page and find the box "Ultimate Member" (see below).

Simple product settings #

Select the role in the dropdown "When this product is bought move user to this role" and then update the product page. The selected role will be assigned to members who will buy this product on checkout.

Image - Settings on wp-admin > Products > Edit product

Subscription product settings #

You'll see more settings for a product-subscription if the plugin WooCommerce Subscriptions is installed. These settings allow you to select a role for each status of the subscription. See Subscription Status Guide.

Image - Settings on wp-admin > Products > Edit product

The extension saves a product-subscription settings to the subscription meta on purchase and uses saved settings to change a role when subscription status is changed. Changing a product-subscription setting influences future subscriptions but doesn't influence existing subscriptions.

The extension removes a role related to the old subscription status and assigns a role related to the new subscription status if these roles differ. The extension does not remove other roles if the user has multiple roles. The extension does not remove roles added manually and roles added by third-party plugins. You can use this code to patch the role assignment logic to remove all old roles.

Profile Menu settings #

The extension adds the tab "Activity" into the profile page menu. Administrators can hide/show this tab and manage who can see this tab.

Purchases Tab – Allows to enable/disable "Purchases" item in the Profile menu.
Who can see Purchases Tab? – Manage access to the "Purchases" tab in the Profile menu.
Product Reviews Tab – Allows to enable/disable "Product Reviews" item in the Profile menu.
Who can see Product Reviews Tab? – Manage access to the "Product Reviews" tab in the Profile menu.

Image - Settings on wp-admin >Ultimate Member > Settings > Appearance > Profile Menu

Profile tabs #

The extension adds tabs to members profiles. Administrators can hide/show this tab and manage who can see this tab using settings on wp-admin > Ultimate Member > Settings > Appearance > Profile Menu

Purchases

Note: The "Purchases" profile tab displays products, not orders. Look at the "My Orders" account tab to see orders.

Product Reviews

User Role settings #

Each user role has settings that manage what a member can see on the account page. To modify these settings, go to wp-admin > Ultimate Member > User Roles and choose which user role to modify. You will be navigated to the page "Edit User Role". Scroll down to the box "WooCommerce", you'll see settings:

Display purchases tab in profile?
Display reviews tab in profile?
Display billing address under account?
Display shipping address under account?
Display orders under account?
Display subscriptions under account?
Display downloads under account?
Display payment methods under account?

Image - Settings on wp-admin > Ultimate Member > User Roles > Edit Role

Account tabs #

The extension adds tabs to the Account page. Administrators can enable or disable each tab for each user role using settings in the box "WooCommerce" on the page "Edit Role".

Billing Address, Shipping Address