WooCommerce Memberships is not just another plugin for restricting your site’s content: it’s an easy-to-use, site-wide membership solution that brings your content, shop, and memberships together.

Memberships allows you to create an entire membership system that’s seamlessly tied to your store.

You can restrict your content to members, but you can also “drip” that content over time to schedule when members have access. Sell access to memberships, include memberships with product purchases, manually assign memberships, and completely integrate member perks within your store.

Sell or Assign Memberships

Memberships are not a specific type of WooCommerce product; instead, membership plans are created independently from products. This lets you determine how access is granted for maximum flexibility. You can assign 0 or more products (of almost any type) to a membership plan to support several types of memberships:

• sell a membership as stand-alone product — create a product for the membership, then tie the plan to that product to sell it
• grant access to a membership as part of a product purchase — i.e., buy a subscription for a meal box, get access to the recipes section for free
• grant access to the same membership from several products (i.e., a yearly purchase or a monthly subscription)
• assign memberships manually for an invite-only members area

  

Strategically Grant Content Access

You put a lot of work into your members-only content, so Memberships lets you schedule when your members should have access to it. You can drip content, which means that you can schedule when members should have access to your content. For example, you can require that customers be a member for a week before they can access certain posts or pages.

This gives you more control over how members begin using your site and lets you introduce members to your content at your pace.

When you use this with Subscriptions, you can even determine which content is included in a free trial period with content dripping rules.

Turn Your Store into a Purchasing Club

Memberships lets you create members-only products so that your site can become a purchasing club, or let you offer certain products exclusively to members.

You can restrict product viewing to members, which means these products will be hidden from non-members in your shop. You can also restrict purchasing, which means that products are public, but only members can buy them.

You can also drip product access so that members don’t get access to products immediately.

Offer Better Shipping Options to Members

Members should be your most loyal customers, so giving them perks that encourage them to purchase repeatedly from you keeps them coming back for more. Memberships extends your free shipping settings so you can offer free shipping directly to your members, while requiring non-members to meet other criteria (like having a coupon or minimum order amount).

Reward Members with Special Discounts

Since you may want to give your members certain perks, you can provide member discounts for all products, some products, or certain product categories.

Automatically Show Members Their Perks

While membership management should be easy on you, it should be easy on your members, too. Members can find all of the information they need about their memberships in the Member Area. Members can access the area for any membership from the “My Account” page by clicking “View”.

You can enable any or all sections of the member area to show members a list of accessible content (post and pages), products, discounts, and / or public membership notes. If a member will have access to content in the future, the member can see the access date as well.

Import or Export Members

You have a lot of tools to manage members within WooCommerce, but you may want to connect to other services too, such as importing a member list into an email tool. Memberships lets you export members to a CSV file so that you can get member data out of WooCommerce and into other tools.

You can also import members via CSV to add new memberships, create new users, or bulk-update existing members by merging your file with existing data.

Simplify Communication with Members

When you run a membership site, you spend a lot of time on customer service and managing members. We’ve tried to make that as easy as possible with Memberships. We’ve added “Membership Notes” so that you can track information about memberships for a customer, add your own notes for your reference, and even easily communicate with a particular member by sharing a note with them via email.

You can also use expiration and renewal reminder emails to let members know of ending memberships and prompt them to renew or upgrade.

Memberships + Subscriptions

Memberships is fully functional as a stand-alone membership solution, but it works very well with the most advanced eCommerce recurring payments solution available: WooCommerce Subscriptions.

When both plugins are active, Memberships can leverage some features of Subscriptions to give you more flexibility over membership billing (more details in our documentation):

• Memberships can use recurring billing (i.e., monthly payments) for the membership rather than a set term (such as a year)
• Memberships can use Subscriptions as a payment plan, but control access length itself to support installment payments
• Free trials can be used for the membership via a subscription
• Content restriction and dripping can include or exclude free trial periods so you control what content is available in trials
• Members can pause their own memberships by suspending a subscription
• Members can upgrade or downgrade memberships by switching a subscription
• Upgrades and downgrades can leverage Subscription’s proration to ensure that membership costs are accurate

Even if you don’t want to use recurring billing, you can leverage the other features of Subscriptions by setting the subscription length to one billing cycle so you can take advantage of upgrades and downgrades or trial periods.

Selling Memberships to Companies or Groups

Need to sell memberships to teams, companies, or groups instead? Check out the Teams for WooCommerce Memberships extension (purchased separately). This plugin adds on to WooCommerce Memberships, letting to sell access to a group of users instead of an individual.

How to Get Started

Ready to create memberships for your customers? You can get going with these steps:

1. Buy this extension 
2. Download and install Memberships in your WooCommerce store
3. Create your Membership Plans and Members
4. Check out our extensive documentation for any advanced setup help
5. That’s it! Sit back and enjoy your fully integrated membership site!

The post WooCommerce Memberships first appeared on CODIBU.

Memberships offers profile fields so you can gather and store important information about your members to help you support and market your memberships more effectively. In this document, we’ll cover how to create and manage profile fields, as well as how they impact the member experience.

Requirements

• Memberships v1.19+
• Teams for Memberships v1.5+, to use team functionality

Creating profile fields

Follow the steps to create profile fields:

1. 1. Go to WooCommerce > Memberships > Profile Fields.
   2. Click Add profile field.

1. 1. Add a Name for the profile field. This can be an internal name, but will also be shown to members if you don’t also update the Label field.
   2. Update the following fields:
      • Slug: Unique identifier for the profile field. The slug will be used during import / export. You can enter your own slug, or one will be created automatically upon saving.
      • Field type: Select the field type. This controls what type of information the member can enter in the field.
      • Default value: Only visible when Field type is set to “Checkbox”. Determine whether the checkbox should be enabled (checked) or disabled (unchecked) by default. For other field types that support defaults, the default value(s) are managed on the Field Options tab.
      • Memberships plans: Select the membership plan(s) where these fields should be applied. Leave blank to apply fields to members of any plan.
      • Editable by: Determine who can edit this field. If fields are admin-only, they won’t be visible or editable by members. If members can edit fields, they can do so from any of the Show field on locations.
      • Show field on: Only visible when Editable by is set to “Members and admins”. Determine where members should have access to this field. Displaying the field on the product page, registration form, or team member invite is helpful for fields that should be populated when a member first joins the plan.
      • Label: Only visible when Editable by is set to “Members and admins”. Optionally set a member-facing label for this profile field or leave blank to use the field’s Name instead.
      • Description: Only visible when Editable by is set to “Members and admins”. Optionally set a description for the field, which will be visible to members.
      • Required: Only visible when Editable by is set to “Members and admins”.

1. 1. For Multi Checkbox, Multi Select, Radio, or Select field types, go to the Field options tab. For Checkbox, File, Text, or Text Area field types, this tab is disabled so you can skip to step 7.
   2. On the Field options tab, use the Add new option button to add options for the profile field that members may select. You may also determine which option(s) should be selected by default. You can set multiple defaults for fields that accept multiple inputs (e.g. Multi Checkbox and Multi Select).

1. Click Create to save the field.

Managing member profile fields

On the WooCommerce > Memberships > Members page, you can view profile field entries for your members. You can show / hide profile fields by adjusting the Screen Options. You can also use the filter to view members based on their field entries.

As a site admin, you can always view and edit profile fields from the Edit User Membership page (WooCommerce > Memberships > Members). If you modify a field, members may be able to see your changes based on the Editable by and Show field on settings (i.e. if profile fields are visible in the My Account area).

Import / export

If you need to view or modify profile fields in bulk, you can do so from WooCommerce > Memberships > Import / Export tab. Click here for more general information about this tool.

When exporting members, you can select the Include profile fields setting to ensure profile fields are added to the export.

You can also import profile fields along with members to update these fields in bulk.

Please keep in mind a few things when importing profile fields:

• The column header should use the profile field’s slug to ensure Memberships matches the content with the right profile field.
• Field values are case-sensitive, and will not be imported if they don’t exactly match listed field options (when applicable).
• When updating checkbox fields, “yes” means that the field is selected / checked and “no” means the field is not selected / unchecked.
• If you clear the contents of a required profile field, the field will retain its previous value (i.e. it will not be cleared).

Using the REST API

Member profile fields are also available via REST API! Check out our WooCommerce Memberships REST API documentation for more information.

Member experience

The member experience with profile fields will largely depend upon the field’s Editable by and Show field on settings. This lets you control who can see profile fields, and where they can see or interact with them.

Here are a few examples of how you might setup profile fields to support different use cases:

I want to use profile fields as internal fields for admins only.

• Setup: Set Editable by to “Admin-only”.
• Result: Admins can populate and manage profile fields, but members themselves will never see the fields.
• Field examples: Designate high-value accounts; upload internal notes.

I want to collect information from members when they join a plan.

• Setup: Set Editable by to “Members and admins”; set Show field on to “Product page” and / or “Registration form”, depending on how members join your plan.
• Result: Members will see these profile fields when they view a product that grants membership access or when registering for an account, when registration grants access to a membership. You can also require profile fields to ensure prospective members can’t purchase or register without those fields populated. Please be careful when requiring profile fields for product purchase or registration! These should only be fields that absolutely must be populated, since you don’t want to block membership purchase or registration with complex field requirements.
• Field examples: Information that does not change over time, e.g. demographics, interests, “how did you hear about us?”, etc.

I want to collect information from members when they join that should be maintained and updated by members over the course of their membership.

• Setup: Set Editable by to “Members and admins”; set Show field on to “Product page” and / or “Registration form”, depending on how members join your plan, and “My Account”.
• Result: Similar to the above use case, members will be asked (or required) to populate profile fields when joining a plan, but can also update those fields as needed from the My Account page.
• Field examples: Information that does change over time, e.g. number of pets, fitness details, etc.

I want to collect information from team members when they register to join a team.

• Setup: Set Editable by to “Members and admins”; set Show field on to “Team member registration” (only visible when Teams for Memberships is active).
• Result: When users are invited to join a team, they will see these profile fields on the registration form.
• Field examples: Company role, school grade, etc.

Populating fields during registration or purchase

When the Show field on setting allows profile fields to be presented on the “Product page” or “Registration form”, this means that prospective members will have the ability to populate these fields when joining a membership.

Profile fields will only be shown at registration or on the product page when the Membership plans field includes a plan that grants access upon registration or by purchasing that product. In other words, the fields are only presented in areas that are related to how members join the plans listed in the profile field settings.

 Important! If profile fields are required, users cannot register / purchase without populating these fields. Please be careful about making too many profile fields required, as this could impact your conversions.

On the registration form, fields will be listed below the username / email / password fields.

On the product page, fields will be listed near the quantity and Add To Cart buttons.

Updating fields in the My Account area

When the Show field on setting allows profile fields to be presented on the “My Account” area, merchants can view and manage their profile fields from the account area, under the My Profile tab. From there, members can update their profile fields as needed.

Teams for Memberships support

When Teams for Memberships is active, merchants can also configure the Show field on setting to “Team member registration”, which will present the profile fields to potential team members when they are registering to join the team.

The post Memberships Use Case: Wine Club first appeared on CODIBU.

• import a CSV of your members to update or merge membership data
• import a CSV of members to create new memberships (and even create new user accounts if needed)
• export all members, or export members based on status, plan, start date, or expiration date
• export selected members to CSV using a bulk action

This document will show you how to import or export members using the native Memberships import and export capabilities, along with creating memberships for existing users.

If you want to export members to move them to MailChimp, check out MailChimp for Memberships, which will automatically sync your member list with a MailChimp list and keep it updated as members change status.

Developers: You may also want to check out this community plugin to add CLI support for imports, which imports via command line for large data sets, and our REST API documentation, which lets you read user membership data.

Exporting members

You may want to export members to an external service, such as an email service, to segment your newsletters by status or plan type (MailChimp users may be interested in MailChimp for Memberships instead). You may also use a member CSV to export members, make changes, then re-import / update memberships. These are possible with the native exporter.

The exporter will provide several columns, such as the user membership ID; membership plan ID, slug, and name; member email; member name; and membership start date. You can view example import and export CSV files in this Google Sheet — note that there are several sheets that you can choose from at the bottom.

A quick note: when members are exported, the member_since and membership_expiration columns will show the member start and end dates (respectively) in the site’s selected timezone. You can import these members later, just be sure to select the site timezone for the import file as well.

If you would like to export in UTC time instead, you can add this small code snippet wherever you keep custom code  to change the exported time:

add_filter( 'wc_memberships_csv_export_user_memberships_dates_in_utc', '__return_true' );

To export members, go to WooCommerce > Memberships > Import / Export, and ensure you’re on the “Export to CSV” tab. Here you can configure export options to export all members or groups of members.

Combinations of these settings can be used to get a customized list of members.

• Plan – Select plans if you’d like to export only members belonging to certain plans. Leave this blank to export members of any plan.
• Status – Select membership statuses if you’d like to export only members who have certain statuses (ie only “active” and “complimentary” members). Leave this blank to export members with any status.
• Start Date – You can optionally restrict the export based on the member’s start date. Add a range to export members who signed up during that date range; you can also leave ranges open ended, such as “From ___ to 2016-05-01”, which will give you any member who signed up before May 1, 2016. Leave this blank to ignore start date in the export.
• End Date – You can optionally restrict the export based on the member’s expiration date. Add a range to export memberships that expire during that date range; you can also leave ranges open ended, such as “From ___ to 2016-05-01”, which will give you any member whose membership expired before May 1, 2016. (This would also exclude open-ended / unlimited memberships!) Leave this blank to ignore expiration date in the export.
• Meta Data – Enable this to include all meta data for a membership, such as paused date, or data added by other plugins
• Separate fields by – Changes the CSV delimiter, and defaults to comma; only change this if you know what you’re doing.

Click “Export” to generate your CSV file. Note that you must keep your browser window open until the export completes; closing the browser window will abort the export.

Bulk exporting members

You can also export a selected group of members from the “Members” list. Click the checkmarks next to the desired members, then select the “Export to CSV” bulk action. When you click “Apply”, a CSV export of the selected members is generated.

Troubleshooting exports

• If your CSV file isn’t generated, please double-check any export options you’ve set. You may be using option to limit the member list that do not correspond to any memberships on your site.

If these troubleshooting steps do not help you, please submit a help request and we’d be happy to assist.

Import via grant access action

Before you decide that you need to import members, you should consider using the “Grant access” action for your plans to programmatically create memberships. Here’s a good set of questions to ask yourself before determining whether you should use this or an import:

• Do you already have existing orders for purchases of your membership product? Use “Grant access” — this will create new memberships and tie them to the order record the membership was purchased in.
• Do you already have existing subscriptions? If yes, do they include the product that grants access to the membership as a line item? If so, you can use “Grant Access” to create your memberships, as both orders and subscriptions assigned to users are checked.

You can read more about how the “Grant access” action works in our user memberships document.

Requirements for import

In order to bulk create or update user memberships, you must already have the following:

• Membership Plans: You must already create your membership plans under WooCommerce > Memberships > Membership Plans. You may want to optionally create rules and other settings for your plan, but only the plan itself needs to exist to import.
• Membership Plan IDs or slugs: You want to note the ID (post ID) or the slug for each membership plan; this will be used within the import to designate which membership plan the user will be assigned to (users can be assigned to multiple plans if desired). If you do not know how to get user or post IDs from WordPress, we recommend this tutorial.
• User identifer: When updating existing user memberships, you will need a way to identify the user you want to modify. You can use the user_membership_ID to identify an existing user and their membership plan. If you include membership_plan_ID or membership_plan_slug, you can instead use user_ID, user_name, or member_email to identify an existing member.

Formatting import CSVs

While you may be used to creating your CSVs in Microsoft Excel, we recommend against this, as Excel can add extra markup. Instead, we recommend using Google Drive / Google Sheets to create your spreadsheet, and export this as a CSV file. If you have an existing CSV, you can import it to Google Drive by creating a sheet, then going to File > Import > Upload to add your existing spreadsheet.

Once your spreadsheet has been created, you can export it by downloading as a CSV, which will let you then import into WordPress with this CSV:

 

If you would like an example to work from, you can check out our example import and export CSV files and save these to work from. You can either click File > Download as > CSV as outlined above, or right-click on a specific sheet and use “Copy to” to move this to your own Google Sheet.

If you absolutely must use Excel, the “Window Comma Separated (csv)” format should be used, not “MS-DOS Comma Separated (csv)”.

Set up your CSV with one row per user membership. If a customer / member has more than one membership, you will need a row for each membership that should be added.

Import: column names

Your column names must exactly match the column names in this list for a successful import.

*The available user membership statuses are:

** You will be able to select whether your dates and times are in UTC or in your site’s timezone while importing.

Importing members

To import members, first be sure that you have a properly formatted CSV file ready to go. If you like some examples, check out our example import and export CSV files (there are multiple sheets you can choose from at the bottom).

Navigate to WooCommerce > Memberships > Import / Export and click on the “Import from CSV” section. This will allow you to select your import options and upload your CSV file to process.

• Choose a file from your computer – Upload your properly-formatted CSV file of memberships here.
• Import Options
  • Update existing records if a matching user membership is found – Enable this if you’d like to merge or update memberships from the uploaded CSV. If enabled, when the user membership ID column matches an existing membership, that membership will be updated with your uploaded data. When this setting is disabled, rows with matching user membership IDs are skipped.
  • Allow membership transfer between users… (only shown if “Update existing records… is enabled) – If enabled, when a user membership is matched, but the user ID doesn’t match the current member, the membership will be transferred to the new user in the CSV. When disabled, rows that have mismatched user membership IDs / users will be skipped.
  • Create new user memberships if a matching user membership ID isn’t found – If enabled, when an existing user membership can’t be located from the CSV data, a new one will be created. When disabled, rows with user memberships that can’t be matched will be skipped.
  • Create a new user if no matching user is found – When enabled, if an imported row contains data that doesn’t match an existing user (user ID, username, and email are checked in order), then a new user is created and this membership is assigned to the new user. When disabled, rows without matching users are skipped.
  • Send new account notification emails when creating new users during an import – When enabled, if a new user is created, they’ll be sent the default WooCommerce “New Account” email.
• Default Start Date – When “Create new user memberships…” is enabled, this field is shown. Select a default starting date for any memberships that are created via import; this default is used when the member_since column is blank.
• Dates timezone – Select whether the member_since and membership_expiration dates in your file are in your site’s timezone or in UTC. The export default is the site timezone.
• Fields are separated by – Select the delimiter for your CSV file. Defaults to comma — only change this if you know what you’re doing.

When you’ve added your CSV file and selected your import options, you can click “Upload File and Import”. The file will be analyzed, and members will be imported or updated based on your settings. The plugin will then display a summary of the import for you.

Troubleshooting imports

• You see a “Could not find User Memberships to import from uploaded file.” error: This means your CSV is either missing required information, or is unreadable. Please check your CSV format to ensure the required information is present and all column headers are named exactly as they are in our table. If this is correct, please upload your CSV file to Google Sheets and re-download it, as its format is probably at fault.
• Your import dies in the middle of the process without importing all members: This most likely indicates that you’re importing a larger number of members than your server can handle. Please break your CSV file up and re-try the import, as you can import multiple times. First try breaking the import into half, then in half again, etc, until your import completes successfully. Typically you should be able to import a few thousand rows without issue, but this depends on your hosting environment.

If these troubleshooting steps do not help you, please submit a help request and we’d be happy to assist.

Frequently asked questions

Q: Can I set passwords for members on import?
A: Setting passwords if you create new users is not possible via an import file; the new user will have a password generated by WordPress.

If you’d like to notify new users to allow them to set their password after the account has been created, please enable “Send new account notification emails when creating new users during an import”.

Q: Can I add the customer’s data like the phone number to the export file?
A: The export only currently includes data related to the user membership itself. If you wanted to add additional customer data to this export file, you would need the help of a developer to modify the export file. You could consider 2 options:

• Use the Customer / Order CSV Export as a starting point, and modify the customer export query to only include users with memberships (this would give you an export of members only with all customer data, but not membership-specific data, but this could be added).
• Modify the Memberships export file via custom code to add additional columns as needed to the member export. You can find ample filters in the /includes/utilities/class-wc-memberships-csv-export-user-memberships.php file to modify the export output as needed.

The post WooCommerce Memberships Profile Fields first appeared on CODIBU.

• import a CSV of your members to update or merge membership data
• import a CSV of members to create new memberships (and even create new user accounts if needed)
• export all members, or export members based on status, plan, start date, or expiration date
• export selected members to CSV using a bulk action

This document will show you how to import or export members using the native Memberships import and export capabilities, along with creating memberships for existing users.

If you want to export members to move them to MailChimp, check out MailChimp for Memberships, which will automatically sync your member list with a MailChimp list and keep it updated as members change status.

Developers: You may also want to check out this community plugin to add CLI support for imports, which imports via command line for large data sets, and our REST API documentation, which lets you read user membership data.

Exporting members

You may want to export members to an external service, such as an email service, to segment your newsletters by status or plan type (MailChimp users may be interested in MailChimp for Memberships instead). You may also use a member CSV to export members, make changes, then re-import / update memberships. These are possible with the native exporter.

The exporter will provide several columns, such as the user membership ID; membership plan ID, slug, and name; member email; member name; and membership start date. You can view example import and export CSV files in this Google Sheet — note that there are several sheets that you can choose from at the bottom.

A quick note: when members are exported, the member_since and membership_expiration columns will show the member start and end dates (respectively) in the site’s selected timezone. You can import these members later, just be sure to select the site timezone for the import file as well.

If you would like to export in UTC time instead, you can add this small code snippet wherever you keep custom code to change the exported time:

add_filter( 'wc_memberships_csv_export_user_memberships_dates_in_utc', '__return_true' );

To export members, go to WooCommerce > Memberships > Import / Export, and ensure you’re on the “Export to CSV” tab. Here you can configure export options to export all members or groups of members.

Combinations of these settings can be used to get a customized list of members.

• Plan – Select plans if you’d like to export only members belonging to certain plans. Leave this blank to export members of any plan.
• Status – Select membership statuses if you’d like to export only members who have certain statuses (ie only “active” and “complimentary” members). Leave this blank to export members with any status.
• Start Date – You can optionally restrict the export based on the member’s start date. Add a range to export members who signed up during that date range; you can also leave ranges open ended, such as “From ___ to 2016-05-01”, which will give you any member who signed up before May 1, 2016. Leave this blank to ignore start date in the export.
• End Date – You can optionally restrict the export based on the member’s expiration date. Add a range to export memberships that expire during that date range; you can also leave ranges open ended, such as “From ___ to 2016-05-01”, which will give you any member whose membership expired before May 1, 2016. (This would also exclude open-ended / unlimited memberships!) Leave this blank to ignore expiration date in the export.
• Meta Data – Enable this to include all meta data for a membership, such as paused date, or data added by other plugins
• Separate fields by – Changes the CSV delimiter, and defaults to comma; only change this if you know what you’re doing.

Click “Export” to generate your CSV file. Note that you must keep your browser window open until the export completes; closing the browser window will abort the export.

Bulk exporting members

You can also export a selected group of members from the “Members” list. Click the checkmarks next to the desired members, then select the “Export to CSV” bulk action. When you click “Apply”, a CSV export of the selected members is generated.

Troubleshooting exports

• If your CSV file isn’t generated, please double-check any export options you’ve set. You may be using option to limit the member list that do not correspond to any memberships on your site.

If these troubleshooting steps do not help you, please submit a help request and we’d be happy to assist.

Import via grant access action

Before you decide that you need to import members, you should consider using the “Grant access” action for your plans to programmatically create memberships. Here’s a good set of questions to ask yourself before determining whether you should use this or an import:

• Do you already have existing orders for purchases of your membership product? Use “Grant access” — this will create new memberships and tie them to the order record the membership was purchased in.
• Do you already have existing subscriptions? If yes, do they include the product that grants access to the membership as a line item? If so, you can use “Grant Access” to create your memberships, as both orders and subscriptions assigned to users are checked.

You can read more about how the “Grant access” action works in our user memberships document.

Requirements for import

In order to bulk create or update user memberships, you must already have the following:

• Membership Plans: You must already create your membership plans under WooCommerce > Memberships > Membership Plans. You may want to optionally create rules and other settings for your plan, but only the plan itself needs to exist to import.
• Membership Plan IDs or slugs: You want to note the ID (post ID) or the slug for each membership plan; this will be used within the import to designate which membership plan the user will be assigned to (users can be assigned to multiple plans if desired). If you do not know how to get user or post IDs from WordPress, we recommend this tutorial.
• User identifer: When updating existing user memberships, you will need a way to identify the user you want to modify. You can use the user_membership_ID to identify an existing user and their membership plan. If you include membership_plan_ID or membership_plan_slug, you can instead use user_ID, user_name, or member_email to identify an existing member.

Formatting import CSVs

While you may be used to creating your CSVs in Microsoft Excel, we recommend against this, as Excel can add extra markup. Instead, we recommend using Google Drive / Google Sheets to create your spreadsheet, and export this as a CSV file. If you have an existing CSV, you can import it to Google Drive by creating a sheet, then going to File > Import > Upload to add your existing spreadsheet.

Once your spreadsheet has been created, you can export it by downloading as a CSV, which will let you then import into WordPress with this CSV:

If you would like an example to work from, you can check out our example import and export CSV files and save these to work from. You can either click File > Download as > CSV as outlined above, or right-click on a specific sheet and use “Copy to” to move this to your own Google Sheet.

If you absolutely must use Excel, the “Window Comma Separated (csv)” format should be used, not “MS-DOS Comma Separated (csv)”.

Set up your CSV with one row per user membership. If a customer / member has more than one membership, you will need a row for each membership that should be added.

Import: column names

Your column names must exactly match the column names in this list for a successful import.

*The available user membership statuses are:

** You will be able to select whether your dates and times are in UTC or in your site’s timezone while importing.

Importing members

To import members, first be sure that you have a properly formatted CSV file ready to go. If you like some examples, check out our example import and export CSV files (there are multiple sheets you can choose from at the bottom).

Navigate to WooCommerce > Memberships > Import / Export and click on the “Import from CSV” section. This will allow you to select your import options and upload your CSV file to process.

• Choose a file from your computer – Upload your properly-formatted CSV file of memberships here.
• Import Options
  • Update existing records if a matching user membership is found – Enable this if you’d like to merge or update memberships from the uploaded CSV. If enabled, when the user membership ID column matches an existing membership, that membership will be updated with your uploaded data. When this setting is disabled, rows with matching user membership IDs are skipped.
  • Allow membership transfer between users… (only shown if “Update existing records… is enabled) – If enabled, when a user membership is matched, but the user ID doesn’t match the current member, the membership will be transferred to the new user in the CSV. When disabled, rows that have mismatched user membership IDs / users will be skipped.
  • Create new user memberships if a matching user membership ID isn’t found – If enabled, when an existing user membership can’t be located from the CSV data, a new one will be created. When disabled, rows with user memberships that can’t be matched will be skipped.
  • Create a new user if no matching user is found – When enabled, if an imported row contains data that doesn’t match an existing user (user ID, username, and email are checked in order), then a new user is created and this membership is assigned to the new user. When disabled, rows without matching users are skipped.
  • Send new account notification emails when creating new users during an import – When enabled, if a new user is created, they’ll be sent the default WooCommerce “New Account” email.
• Default Start Date – When “Create new user memberships…” is enabled, this field is shown. Select a default starting date for any memberships that are created via import; this default is used when the member_since column is blank.
• Dates timezone – Select whether the member_since and membership_expiration dates in your file are in your site’s timezone or in UTC. The export default is the site timezone.
• Fields are separated by – Select the delimiter for your CSV file. Defaults to comma — only change this if you know what you’re doing.

When you’ve added your CSV file and selected your import options, you can click “Upload File and Import”. The file will be analyzed, and members will be imported or updated based on your settings. The plugin will then display a summary of the import for you.

Troubleshooting imports

• You see a “Could not find User Memberships to import from uploaded file.” error: This means your CSV is either missing required information, or is unreadable. Please check your CSV format to ensure the required information is present and all column headers are named exactly as they are in our table. If this is correct, please upload your CSV file to Google Sheets and re-download it, as its format is probably at fault.
• Your import dies in the middle of the process without importing all members: This most likely indicates that you’re importing a larger number of members than your server can handle. Please break your CSV file up and re-try the import, as you can import multiple times. First try breaking the import into half, then in half again, etc, until your import completes successfully. Typically you should be able to import a few thousand rows without issue, but this depends on your hosting environment.

If these troubleshooting steps do not help you, please submit a help request and we’d be happy to assist.

Frequently asked questions

Q: Can I set passwords for members on import?
A: Setting passwords if you create new users is not possible via an import file; the new user will have a password generated by WordPress.

If you’d like to notify new users to allow them to set their password after the account has been created, please enable “Send new account notification emails when creating new users during an import”.

Q: Can I add the customer’s data like the phone number to the export file?
A: The export only currently includes data related to the user membership itself. If you wanted to add additional customer data to this export file, you would need the help of a developer to modify the export file. You could consider 2 options:

• Use the Customer / Order CSV Export as a starting point, and modify the customer export query to only include users with memberships (this would give you an export of members only with all customer data, but not membership-specific data, but this could be added).
• Modify the Memberships export file via custom code to add additional columns as needed to the member export. You can find ample filters in the /includes/utilities/class-wc-memberships-csv-export-user-memberships.php file to modify the export output as needed.

The post WooCommerce Memberships Import and Export first appeared on CODIBU.

Note that if no rules are applied to content, that content is publicly accessible. Once a rule has been applied to content, that content is restricted, and only accessible to memberships that grant access to that content.

Rules hierarchy: which rules override others

There are situations in which restriction rules could overlap. For example, you could have a restriction set that members can access the “Coffee” category of posts, but only after 1 week has passed. All posts in this category will now abide by this rule.

However, if you also create a rule for the “Moka Latte” post in the “Coffee” category, you could say that this post is restricted, but accessible immediately. This introduces a conflict, as both of these rules apply to the same content.

When this occurs, Memberships always defers to the more specific rule. In this case, the post will be accessible immediately, because a rule for the post is more specific than a rule for the entire category.

Here are the basic rules that Memberships follows:

• Rules that restrict an entire content type, such as all blog posts, are put into effect first.
• They can be overridden by more specific rules. You can restrict all blog posts, but then set rules for categories or single posts.
• A rule for blog post categories or tags (taxonomies) will override a rule for all posts, as it is more specific.
• A rule for a single blog post or group of posts will override both rules for an entire content type and for a taxonomy, as this rule is most specific.
• If two rules are of equal specificity, the rule that grants access first will be followed *.

*Example: If a post is in both the “Marvel Superheroes” and “Avengers” categories, rules could be applied to both of these categories that conflict. If “Marvel Superheroes” is accessible after two weeks, and “Avengers” is accessible after one week, the post will be accessible in one week. The earlier access rule will always be used.

This can help you expedite setup, as you may want to delay access to a category, but provide access to one or two posts immediately.

Membership plan page

Restricting content while creating or editing a membership plan provides the most control over content restriction. While editing a plan, you can restrict all pages, posts, categories, or other types of content easily.

You can also create specific restriction rules for individual posts, pages, or taxonomies (such as categories), and determine when members should get access to this content (immediately or after a certain time has passed).

You can learn more about creating plans in the Membership Plans document.

Product restriction

Product restriction is unique because either viewing or purchasing restrictions can be used. Products can be restricted from the plan page as described above, but they can also be restricted while editing the product.

Because products can both grant access to memberships, as well as be restricted by memberships, the product meta box is slightly different from the default Memberships meta box.

To restrict a product while editing it, view the “Memberships” box, and go to “Restrict Content”.

You can create a rule here that will restrict this product to the selected plan, just as if it were added from the plan page.

Note that if you already have restrictions in place that affect more products (i.e., a category-level restriction that affects this product), you cannot edit it from here and must edit it from the plan page.

Content restriction

The Memberships restriction meta box will be added to your pages, posts, and other content while Memberships is active. This will allow you to add membership restriction rules on the fly as you edit or create content.

To restrict a page or post while it’s being edited, simply add a rule to restrict the content to a particular membership plan.

You can also use custom restriction messages if you’d like to tailor the restriction notice to this content. If enabled, this will override the default / global restriction message set under WooCommerce > Settings > Memberships > Messages.

Making content public

If you’ve restricted content, you can still make it public (version 1.1+). While viewing your post, page, product etc., you can disable restrictions. This overrides any and all rules that apply to the content, making it publicly accessible for everyone. This can be done from the “Memberships” meta box while creating or editing the content.

This is an easy way to make teaser content public. For example, you could restrict all posts with a single rule, and then use the “Disable restrictions” option to make some public as a teaser for your membership.

If you have public content with restrictions disabled on your site, this will be listed on the membership plan page for reference.

Restrict content with Memberships Gutenberg blocks

In Memberships 1.15+, you can use Memberships blocks in the Gutenberg editor to easily restrict content to members and non-members.

• The Member Content block restricts content to plan members. You can specify which plan(s) a user must belong to in order to see the content, as well as determine when this content should be visible.
• The Non-Member Content block restricts content to visitors and other non-members. You can specify certain plans that a user must not belong to in order to see the content.

Using Member Content blocks

Follow the steps below to setup a Member Content block for a page or post:

1. 1. Click Add Block and select the Member Content block.
   2. In the Block settings panel, you’ll see the following options:
      • • Membership plans: Specify one or more plans that a user must belong to in order to see the restricted content. If left blank, members of any plan can see this content.

      

      • • Delay access: Determine when members can see this content – immediately, after they’ve been a plan member for a certain length of time, or after a specific date. If you’re using WooCommerce Subscriptions, you can also hide this block until after the free trial period.

      

      • • Restricted content message: Decide what users who do not have access to this block should see instead of the restricted content. By default, the block will be invisible to those without proper access, but you can also use your default restriction message or create a custom message.

      

   3. You can add text or insert other blocks inside the Member Content block. All content within the block will be restricted based on your block settings.

1. When you’re satisfied with your page or post, click Publish. You can visit the site to see how it will appear to members, or visit the page in an Incognito window to see how it will appear to non-members.

Using Non-Member Content blocks

Follow the steps below to setup a Non-Member Content block for a page or post:

1. 1. Click Add Block and select the Non-Member Content block.
   2. In the Block settings panel, you’ll see the following options:
      • • Membership plans: Specify one or more plans that a user must notbelong to in order to see the restricted content. If left blank, users who don’t belong to any plan can see this content.

      

   3. You can add text or insert other blocks inside the Non-Member Content block. All content within the block will be restricted based on your block settings.

1. When you’re satisfied with your page or post, click Publish. You can visit the site to see how it will appear to members, or visit the page in an Incognito window to see how it will appear to non-members.

Restriction shortcode

The [wcm_restrict] shortcode provides an easy way to restrict blocks of content within a page or post. This is most useful when you don’t want to restrict an entire page or post, but portions of the content should only be visible to members, such as tutorial videos or infographics. This will not show a restriction message, so you can use the non-member shortcode if you’d like to add a restriction message.

There are three accepted attributes, but they are all optional:

• plans: the plan slugs or IDs to limit the wrapped content to certain members
• delay: delays access to the wrapped content by a certain time, or makes it available on a particular date
• start_after_trial: delays access to the wrapped content until a trial period is over (when WooCommerce Subscriptions is in use)

Wrapping the content in this shortcode will hide it unless the member is logged in and has the appropriate access. Here are some ways this shortcode can be used:

Restrict content to members only

When used it its most general form, this shortcode will restrict content to any member on your site, regardless of which membership plan the member has. The general format is: [wcm_restrict]Restricted Content[/wcm_restrict]

This is public content.

[wcm_restrict]
This content is only visible to members, regardless of which membership the member has.
[/wcm_restrict]

This content is now public again.

Restrict content to specific members

The shortcode can also accept an attribute to limit the content to specific members. We can add the “plans” argument to restrict this content even further to certain members: [wcm_restrict plans="gold, platinum"]Restricted Content[/wcm_restrict]

You must use the appropriate slugs for your membership plans, which can be viewed from the plans list or by editing the plan.

You can use the plan ID instead of the slug if preferred (which is the same as the WordPress post ID).

This is public content.

[wcm_restrict plans="gold, platinum"]
This content is only visible to gold or platinum members. Members with other plans or non-members cannot see this.
[/wcm_restrict]

This content is now public again.

Delay restricted content access

There are two ways to delay the access members have to content wrapped in the shortcode:

• delay access for a length of time (e.g., 2 weeks)
• delay access until a certain date (e.g., January 1, 2016)

Delaying access for a length of time can accept any time for the delay argument, such as: “3 days”, “2 weeks”, “1 month”, or “2 years”

[wcm_restrict delay="2 weeks"]
This content will be available to members of any plan once they've been a member for two weeks.
[/wcm_restrict]

Delaying until a date can accept several date formats, but we recommend using the ISO standard (yyyy-mm-dd). For example, you can use: “January 1, 2016” or “2016-01-01”

[wcm_restrict delay="2016-01-01"]
This content will be available to members of any plan on January 1, 2016.
[/wcm_restrict]

NOTE: If you use a time, such as “May 1” with no year, be aware that this access may reset each year. For example, this content will be available May 1, 2015 to December 31, 2015, then access will reset and the content is inaccessible again from January 1, 2016 to May 1, 2016. Please ensure that you include a year to be specific about the access date.

You can also delay access based on trial status.

[wcm_restrict start_after_trial="yes"]
This content will be available to all members except those in a free trial from a subscription. They will have access when the free trial ends and the membership moves from "Free Trial" to "Active" status.
[/wcm_restrict]

Using all shortcode attributes

Any or all attributes can be used at a given time to control content access and access delay. For example, you can use all three attributes to restrict access to particular members at a certain time:

[wcm_restrict plans="gold, silver" delay="1 week" start_after_trial="yes"]
This content is available to any silver or gold member one week after the trial period ends. If the membership doesn't have a trial period, access is simply delayed 1 week.
[/wcm_restrict]

Non-member shortcode

Since shortcodes do not display restriction notices, you may want to give your non-members a notice to log in or purchase a membership. You can do so with the [wcm_nonmember] shortcode, which displays portions of content only to non-members. Non-members are guest users or customers who are logged in, but do not have a membership.

The general format is: [wcm_nonmember]Non-member Content[/wcm_nonmember]

This is content everyone sees!

[wcm_nonmember]
Whoops, this video is for members only. If you have a membership, please log in. If not, you can definitely get access! <a href="/membership/">Purchase a membership here</a>.
[/wcm_nonmember]

[wcm_restrict]
Embedded video displayed to members only.
[/wcm_restrict]

Now we're talking to everyone again.

Specifying plans

(Version 1.9+) The non-member shortcode can specific plans if you want to alter its behavior slightly. If you add a “plans” attribute, this will no longer only target non-members; rather, it will target all visitors who are not active members of the specified plan(s).

An example:

[wcm_restrict plans="gold"]
Content only shown to gold members
[/wcm_restrict]

[wcm_nonmember plans="gold"]
Content shown to anyone who is not a gold member, even other members
[/wcm_nonmember]

You can enter a list of one or more plans in this shortcode:

[wcm_nonmember plans="gold, silver"]
This is shown to anyone who does not have a silver OR gold membership active.
[/wcm_nonmember]

Upgrade prompts

When paired with [wcm_restrict] to target certain plans, you can dynamically display content appropriate to the member’s level. Remember, if a member has multiple memberships, they may see multiple messages.

Here’s an example of building a page that shows content only to certain members:

[wcm_nonmember]
Hey there! You've stumbled onto a members-only video :). If you'd like to check out this video, please purchase a Platinum Membership.
[/wcm_nonmember]

[wcm_restrict plans="silver, gold"]
Hey Member! Thanks for checking this page out -- however, it's restricted to Platinum-level members only. If you'd like to access it, please purchase to a Platinum Membership.
[/wcm_restrict]

[wcm_restrict plans="platinum"]
The super secret video for platinum members goes here.
[/wcm_restrict]

The post WooCommerce Memberships Restrict Content first appeared on CODIBU.

Memberships are activated once an order is paid for (processing or completed status) that includes a product that grants access to the membership. They can also be activated manually by a shop administrator.

If a membership is tied to a subscription, then it’s tied into all subscription actions as well:

• If the subscription is active, the membership is active and will not expire — it stays active so long as the subscription is.
• If the subscription is suspended, the membership is paused (which stops access to restricted content).
• If the subscription is cancelled, the membership is cancelled.

Using WooCommerce Subscriptions can allow your customers to upgrade or downgrade their memberships as well. Please see our document on the Subscriptions integration for more details.

Managing user memberships

User Memberships can be viewed from WooCommerce > Memberships > Members. This list will include each membership on your site, so if a user has more than one membership, that user will be listed multiple times.

From this list, you can edit, pause, cancel, or delete memberships by hovering on the user’s name. You can also select multiple users to perform a bulk edit. The only bulk action available is to change the membership status for the selected individuals.

If you only want to view certain memberships, you can filter memberships by:

1. Plan type (i.e., view only silver memberships)
2. Memberships status (i.e., view only expired memberships)
3. Expiration: view plans that expire today, this week, or this month

View or edit members

When you click on a member’s name or the “Edit” action, you’ll be taken to the member management screen. From here, you can edit all memberships that a user has using the tabs to switch between memberships.

Member Details will show you static information about the member: avatar, email, name, and billing address.

Recent Activity will show you recent activity for all memberships tied to this user — status changes, notes, etc. The last 5 notes will be shown, and will display which membership the activity is related to.

Membership Details will show plan details and allow you to edit them. Each membership is displayed in a tabbed layout so you can switch between a user’s memberships.

You can view or change the plan type, status, membership start date, and membership end date. The billing section will show you details on how the membership was purchased.

Membership Notes show both automatically generated member notes (such as purchase details and status changes) and manually added notes for the membership being viewed. You can read more on membership notes below.

Transfer memberships

You can transfer memberships from one user on your site to another using the membership “Transfer” action. When clicked, this will prompt you to select another user for the membership, or to create a new user for the membership.

When transferred, all membership data will stay the same (order data for which the membership was purchased, linked subscriptions, etc) and only the user who owns the membership changes.

User membership statuses

User Memberships can have one of several statuses to help you manage members and content access. Some statuses are used automatically when memberships are purchased, some are only used as the result of manual actions, and some tie into Subscriptions if a subscription grants access to the membership.

*If you’ve delayed content access until after the free trial, the member cannot access it in the trial period. Memberships let you determine which content is included in the trial period so you don’t have to provide access to some content while a subscription is in the trial state.

Members can renew a set-length membership if its status is ‘expired’ by re-purchasing the product that granted access or clicking “Renew” from My Account > Memberships:

Notes on status changes

For the most part, membership statuses are automated. For example, when a set-length membership is purchased, the “Active” status is used automatically, and the status changes to “Expire” when the membership runs out, or “Cancelled” if the member cancels the membership.

When a subscription membership is purchased, the status will be “Free trial” if a trial exists, or “Active” if no trial exists. Membership status changes will automatically change with the subscription status.

There are some actions you should be aware of that will trigger status changes.

• When an order that contained a membership product is marked refunded (the order status is changed to “Refunded”), then the membership purchased in that order will be cancelled.
• When an order is trashed that contains a membership product, the membership purchased in that order will be cancelled.
• If a subscription is cancelled or trashed that has a membership tied to it, then the membership tied to that subscription will be cancelled.
• If a subscription is suspended that has a membership tied to it, then the membership tied to that subscription will be paused.

Membership notes

Membership notes work very similar to WooCommerce order notes, and allow you to track information about, and changes to, user memberships.

Some notes are automatically generated — membership purchases and status changes will generate notes for record keeping.

You can add notes manually to track membership details (i.e., spoke with customer on June 1), or can opt to send the note to the member by clicking “Notify Member”.

These notes can help you track why changes were made (i.e., why the status was changed to “complimentary”), or give you a quick way to get in touch with a specific member.

Notes emailed to a member will have a purple background instead of the default gray to indicate they were sent to the member:

Manually creating user memberships

You can manually create a membership for a customer or any WordPress user in a few steps by going to WooCommerce > Memberships > Members.

First, click the “Add Members” button next to the “Members” title:

You can enter the name (or username) of the user for whom you’d like to add a membership. This will search for the user, and you can select the appropriate user from the list. Or, you can opt to create a new user for this membership:

Once you’ve selected the user or entered the details for the new user, click “Add Member”:

You can now edit the details of the membership, such as the plan and expiration date.

Granting access for previous purchases

If you’d like to grant access to customers who have purchased a particular product before Memberships was activated, you can do so with our previous purchase import. As an aside, if you use the Groups plugin on your site, you can also import members from Groups (please view our Groups integration document for help).

Here’s an overview of how the process works:

• Let’s assume a Silver membership is purchasable via the “Monthly Snack Box” product.
• You’d like to grant memberships to customers who purchased this “Monthly Snack Box” already before it also granted access to the membership or before the Memberships plugin was installed.
• By following this routine, Memberships will search for any processing or completed orders that contain the “Monthly Snack Box” product and grant access to this customer.
• If the customer already has access to the membership, or the purchase was a guest purchase, the order / customer is skipped.
• Any new memberships created from this process will also have expiration dates (if your membership expires) and respect dripping rules. The import date is considered day 1 of the membership, not the purchase date.

Grant Previous Purchase Access

Go to the Membership Plan you’d like to grant access to under WooCommerce > Memberships > Membership Plans. When you click on the plan to edit it, be sure that all products are already assigned to grant access to the membership. The import process will check orders for these products to grant access.

Click “Grant Access” next to “Existing purchases” to begin this workflow.

You’ll see a notice that informs you of the following:

• If this membership exists already for the customer, a new one will not be created.
• If a customer has purchased this product, but does not yet have a membership, one will be created and will use the expiration length, etc., included in the plan.
• If the membership can be purchased via a subscription, only active subscribers with this subscription will have a membership created.

Clicking “Grant access” will begin the import.

You’ll be notified of the number of imported members as soon as the import completes.

Important notes

Here are a few behaviors of which you should be aware while using this import wizard.

• When users are imported, the membership plan’s settings will be respected in terms of content access and expiration. For example, if a membership is valid for one year, and the member is imported from a previous purchase, then the membership will expire one year after the import date.
• Membership plans will not be created if the user already has access to a plan.
• Large imports: If your site is importing a large number of members from previous purchases (i.e., over 2000 users), this process may take some time to complete. You must leave your browser window open to complete this import; closing the window will halt its progress.

The post WooCommerce Memberships User Memberships first appeared on CODIBU.

If you’d like to index some of your protected content for SEO, you can do so with excerpts enabled; you should use “Hide content only” or “Redirect to page” as your restriction mode to do so (we recommend using “Hide content only”).

Restriction modes

When setting up Memberships, you’ll first need to understand the restriction modes available to hide your content from non-members. Members will see content in its entirety if they have access, but non-members can see a few different things depending on these settings.

Hide completely

If you choose to hide content completely from non-members, it will be completely hidden until a membership is purchased or the member with access logs in. This means that restricted blog posts, products, or other content will not be accessible on your site at all and trying to access restricted content will lead to a 404 page.

Restricted posts or other content will not show up in archives, such as your shop or blog archive. If a non-member tries to visit the URL for restricted content, a 404 page will be displayed.

Comments on restricted content are hidden as well since the content cannot be accessed.

As a result, search engines cannot index restricted content. This mode should be used if you want membership content to be completely private.

Hide content only

Hiding content only will restrict content and comments unless a member has access. It differs from hiding completely because restricted content will appear in archives and on your site (such as your blog or shop page).

If content is hidden, restricted pages, posts, and content can be accessed, but none of the content will be displayed. Instead, a restriction notice is shown (only the title and featured image are available).

This is helpful if you want to “tease” restricted content in order to sell your memberships, as non-members can see that this content exists, but cannot access it and will encounter a restriction notice if they try to view the content.

“Hide content only” allows you to optionally show excerpts of content, which will display excerpts to both visitors and search engines.

 Free add-on available! Easily adjust the excerpt length with this add-on so you can control the amount of preview content available to non-members.

You should be aware of how products are treated when content is hidden. In the shop pages, products will be shown, but only the title (and optionally, the short description), will be included — no descriptions or images will be shown.

You can use the “Hide restricted products” setting within the Products settings to avoid this, which will remove restricted products from shop pages. They will still be accessible directly, and will show the content restricted message unless the member has access. The product page looks the same whether the product is hidden from the shop or not:

Redirect to page

Redirecting customers to a page behaves similarly to hiding content only, as content will be included in archives with the title and featured image. This means that restricted blog posts and products will show in your blog or shop, and excerpts can optionally be shown.

However, if the customer tries to access this content (i.e., tries to view the post or product), the customer is redirected to a page that displays the appropriate restriction notice. The customer will also be redirected from archive pages for the restricted term (such as the archive page for a restricted category), not just the individual posts or pages assigned to that term.

The content restricted page should contain the [wcm_content_restricted] shortcode by default. This is a “smart” shortcode that will have the referring source passed in — this means that the shortcode knows where the visitor came from so it can dynamically display the correct restriction message (i.e., one for products or one for content).

You can opt to customize this page or use a generic landing page instead by removing this shortcode or by customizing it with a developer.

General settings

General settings are located on the WooCommerce > Settings > Memberships page under the “General” section.

• Content Restriction Mode – The selected restriction mode determines what happens when a non-member views restricted content.
• Redirect Page – Shown when the Content Restriction Mode is set to “Redirect to page”. Select the page where non-members should be redirected when they try to access restricted content. Defaults to a “Content restricted” page created by Memberships.
• Show Excerpts – Shown when the Content Restriction Mode is not set to “Hide completely”. Select if you want to display excerpts of restricted content for non-members and search engines. By default, excerpts will include the first 55 words of the restricted content, but this length can be changed with a snippet. You can also enter a custom excerpt from within the page or post editor.
• Inherit Parent Restrictions – Select if the restriction rules applied to the “parent” should also apply to its “children” for hierarchical post types, such as pages.
• Redirect members upon login – Select where you want to redirect your members to when they log into your site.
• Login redirect page – Shown when Redirect members upon login is set to “Site page”. Select the page where members should be directed to when they log into your site. If this page is restriced from the member’s plan that is logging in, they will not be redirected.
• Account Erasure Requests – Select if you want to automatically delete memberships when a personal data erasure request is processed. See Memberships Privacy & GDPR for more details.

Groups integration

This settings area will only be shown if the Groups plugin is active on the site. Click Import Members from Groups to bring you to the Groups import workflow where you can import Groups members to Memberships.

Please see the Groups Integration documentation for more details.

Product settings

Product settings are located under WooCommerce > Settings > Memberships, under the “Products” section.

• Apply discounts when purchasing membership – Enable this setting to apply eligible discounts when customers are purchasing the membership product.
• Allow cumulative purchases – Enable this if, should customers purchase multiple products that grant access to a membership plan within the same order, you want to extend the membership length. If disabled, only “one” membership length will be granted per order, regardless of how many products in the order grant access to the plan.
• Discounts apply to subscriptions sign up fees – (Shown if Subscriptions is active) Enable this to apply member discounts to both the subscription sign up fee and the recurring price. If disabled, member discounts will only apply to the recurring price.
• Exclude products on sale from member discounts – Enable this if member discounts should not apply to products on sale.
• Hide restricted products – Enable this setting to remove products with viewing restricted from the shop catalog — applies to restriction modes of “Hide content only” and “Redirect to page”, as “Hide completely” already removes products from the catalog. Products will still be accessible directly.

Messages settings

The messages settings let you control the “content restricted” notices shown to non-members when visiting your site. These messages can adjust based on whether a purchase can grant access or not, along with what kind of content is being viewed.

Restriction messages can accept a limited number of merge tags to dynamically insert content:

• {products} inserts the product(s) needed to gain access.
• {date} inserts date a member will gain access if access has been delayed.
• {login_url} inserts the URL to my account page with the login form. If used, the member will be redirected back to the page this link was clicked from after logging in.
• {login} (or {Login}) inserts a full login link with the anchor text “log in”: Log in. If used, the member will be redirected back to the page this link was clicked from after logging in.

Blog restriction messages

• Post Restricted (Purchase Required) – The message displayed when a blog post is restricted and a membership purchase is required to gain access.
• Post Restricted (Membership Required) – The message displayed if a blog post is restricted, but is restricted to a membership that cannot be purchased (members can only be added by a shop admin).
• Post Delayed (Members) – The message displayed to a member when the member will have access to the post in the future, but not yet.

Page restriction messages

• Page Restricted (Purchase Required) – The message displayed when a page is restricted and a membership purchase is required to gain access.
• Page Restricted (Membership Required) – The message displayed if a page is restricted, but is restricted to a membership that cannot be purchased (members can only be added by a shop admin).
• Page Delayed (Members) – The message displayed to a member when the member will have access to the page in the future, but not yet.

Content restriction messages

These messages are shown for restricted content that is neither a blog post or page, such as content created by other plugins (or other custom post types).

• Content Restricted (Purchase Required) – The message displayed when content is restricted and a membership purchase is required to gain access.
• Content Restricted (Membership Required) – The message displayed if content is restricted, but is restricted to a membership that cannot be purchased (members can only be added by a shop admin).
• Content Delayed (Members) – The message displayed to a member when the member will have access to the content in the future, but not yet.

Product restriction messages

• Product Viewing or Purchasing Delayed – The message displayed when the member will have access to the product in the future, but not yet.
• Product Viewing Restricted (Purchase Required) – The message displayed when the product can’t be viewed / accessed and a membership purchase is required to gain access.
• Product Viewing Restricted (Membership Required) – The message displayed if the product viewing is restricted, but is restricted to a membership that cannot be purchased (members can only be added by a shop admin).
• Product Buying Restricted (Purchase Required) – The message displayed when the product be viewed but not purchased, and a membership purchase is required to gain access.
• Product Buying Restricted (Membership Required) – The message displayed if the purchasing the product is restricted, but is restricted to a membership that cannot be purchased (members can only be added by a shop admin).

Discount messages

• Product Discounted (Purchase Required) – Enter a message if you’d like to enable discount messages. This message will be displayed on the product page to non-members or guests if the product is discounted for a membership that can be purchased. Leave blank to disable the message.
• Product Discounted (Membership Required) – Enter a message if you’d like to enable discount messages. This message will be displayed on the product page to non-members or guests if the product is discounted for a membership that cannot be purchased. Leave blank to disable the message.
  

• Member Discount Login Reminder – Select when and where to display a login notice for members: never, on the cart page, at checkout, or both. This notice will only display to remind members to log in if a product in the cart has a member discount.
  

  

• Member Discount Login Message – Change the text of the discount login notice. Leave blank to use the default text, which will adjust based on the number of discounted items in the cart.

Shipping settings

Memberships can allow you to offer free shipping exclusively to your members. This can be done by adjusting the free shipping rate settings.

If you’d like to offer a free shipping method only to your members, you can choose that free shipping requires an active membership in the shipping method settings. You can then determine which members are offered this rate.

You can add one or more member-specific shipping rates. Non-members and guests will not be offered this rate in the cart and checkout; this rate is only offered to logged-in members.

If you’d like to also offer free shipping to non-members and guests, you can still do so with regular free shipping rates. If you do add a non-member rate, we recommend adding your members who will get their own free shipping as “disallowed”. This way, members do not see more than one available free shipping rate at a time.

In this way, you can offer specific free shipping to both members and some guests in your store.

Email settings

Memberships adds five new emails under WooCommerce > Settings > Emails.

• Membership note – Sent to members when a member-facing note has been added to a membership (not sent for private/default notes).
• Membership ending soon – Sent to members 1 to 60 days before a membership ends.
• Membership ended – Sent to members when their membership expires.
• Membership renewal reminder – Sent to members 1 to 60 days after a membership ends to ask for renewal. This email is only sent for memberships that are accessed via product purchase, since other membership types can’t be renewed.
• Membership activated – Sent to members when a delayed membership is activated.

For Ending soon and Renewal reminder emails, you can also reschedule all emails if you want to adjust sending times. Clicking the “Reschedule” action after saving your settings will allow you to adjust email schedules for all existing memberships (without this action, settings changes only apply to new memberships moving forward).

Content can be customized on a per-plan basis for ending soon, ended, and renewal reminder emails to respond to whether the plan can be renewed, can upsell other plans, etc.

For example, if a registration-based membership ends, this cannot be renewed, but you may want to upsell a “full” or paid membership. The “Membership ended” email provides an opportunity to do so:

Endpoint settings

Under WooCommerce > Settings > Advanced, you’ll find the endpoint settings for your store’s account section. Memberships adds a “My Membership” endpoint for the Members’ Area, which displays accessible content, etc, to the member.

If you’d like to disable access to the members’ area, you can delete this endpoint, and the “Memberships” item will not appear in the account navigation.

This setting will default to members-area for the endpoint, which means the URL for the Member Area will look something like this:

http://mysite.com/my-account/members-area/1008/my-membership-content/

Where 1008 is the ID of the membership plan for which the member is viewing accessible content / products / etc, and the “my-membership-content” will adjust based on which section is viewed.

The post WooCommerce Memberships Settings first appeared on CODIBU.

Our goal is to ensure this plugin is easy to work with for customizations. If a hook doesn’t exist where you think it should, please submit a ticket so we can consider its addition.

This reference lists helpful filters, actions, and methods and is meant to be a directory. This document may not outline every available or hook or method, so please see the plugin’s inline documentation for additional details on parameters, returned values, and usage, or example usage.

If you need help changing this code or extending it, we recommend getting in touch with a WooExpert or a developer at Codeable.

Data Structure

Teams for WC Memberships leverages a few custom data structures, but you would also benefit from being familiar with the data structure of WooCommerce Memberships itself. The Memberships Data Structure overview and developer documentation will be helpful resources.

We also recommend reviewing the methods in the WC_Memberships_User_Membership class, as these methods are quite commonly used by developers to manipulate user memberships. User memberships can easily be instantiated with the wc_memberships_get_user_membership() global method.

For its own functionality, Teams adds a “team” and “invitation” custom post type to manage groups of members, and invitations to join a team. Teams also makes modifications to particular products and membership plans to store additional data related to purchasing a team, and managing team access.

Teams

Post type: wc_memberships_team

The team post serves as a data store for all team information, such as purchase record, owner, and members (along with the roles of each member on the team).

The team owner is stored as the post_author, given a team can only have one owner, and the configured team name is stored as the post_title. The team’s post_parent is the post ID of the Membership Plan to which the team grants access (as currently a team can only provide access to a single plan).

Team posts store other data about the team as well:

Team Invitation

Post type: wc_team_invitation

Invitation posts store data about invitations sent to particular emails. The invitation post will use custom statuses to determine the invitation status: wcmti-pending, wcmti-accepted, or wcmti-cancelled. The post_author is the user who sent the invitation, while the post_parent is the team to which the invitation belongs.

Pending invitations will store no meta, but accepted invitations will add 2 pieces of meta data:

Product Data

To associate a team with a product or variation, the product post will store a few pieces of data:

User capabilities

Teams provides a few custom WP User capabilities for both admin management of teams, and frontend management for team owners and managers.

Team Lifecycle

You can hook into the team lifecycle at several instances to fire third party code or adjust teams.

Created Team Filters

When a new team is created, the team data can be filtered.

wc_memberships_for_teams_new_team_data

@since

 

1.0.0

 

@param

 

array $data team data

 

@param

 

array $args an array of team arguments {

• • @type string $name the team name
  • @type int $plan_id the plan id the team has access to
  • @type int $owner_id the user id the team is assigned to
  • @type int $product_id the product id that creates the team (optional)
  • @type int $order_id the order id that contains the product that creates the team (optional)

}

Created Team Actions

Team creation and management also fires several actions that can be used to run additional code.

wc_memberships_for_teams_team_created

Fires after a team has been created. This action hook is similar to wc_memberships_for_teams_team_saved but doesn’t fire when teams are manually created from admin.

@since

 

1.0.0

 

@param

 

Team $team the team that was just created

 

@param

 

bool $updating whether this is a post update or a newly created team

wc_memberships_for_teams_team_saved

Fires after a team has been created. This action hook is similar to wc_memberships_for_teams_team_created but will also fire when a team is manually created in admin, or upon an import or via command line interface, etc.

@since

 

1.0.0

 

@param

 

Team $team the team that was just saved

 

@param

 

bool $updating whether this is a post update or a newly created team

wc_memberships_for_teams_process_team_meta

Fires when a team is saved/updated from admin.

@since

 

1.0.0

 

@param

 

int $post_id post identifier

 

@param

 

WP_Post $post the post object

Invitation Lifecycle

You can hook into the team lifecycle at several instances to fire third party code or adjust invitations.

Created Invitation Filters

When a new invitation is created, the invitation data can be filtered.

wc_memberships_for_teams_new_invitation_post_data

@since

 

1.0.0

 

@param

 

array $data new invitation post data

 

@param

 

array $args array of Invitation arguments {

• • @type string $email email of the invitation recipient
  • @type int $team_id the team id
  • @type int $sender_id the sender user id
  • @type string $role the role to assign the invited user to

}

wc_memberships_for_teams_join_team_redirect_to

Filters the URL to redirect to when a user joins a team by invitation or via link

@since

 

1.0.4

 

@param

 

string $redirect_to URL to redirect to

 

@param

 

SkyVergeWooCommerceMembershipsTeamsTeam $team the team object

 

@param

 

false|SkyVergeWooCommerceMembershipsTeamsInvitation $invitation the invitation object

Created Invitation Actions

Invitation creation will also fire an action that can be used to run additional code.

wc_memberships_for_teams_invitation_created

Fires after an invitation has been created.

@since

 

1.0.0

 

@param

 

SkyVergeWooCommerceMembershipsTeamsInvitation $invitation the invitation that was just created

Frontend Hooks

This is a non-exhaustive list; these represent some often-used frontend hooks.

Frontend Filters

wc_memberships_for_teams_product_team_user_input_fields

Filters user input fields for a team product.

@since

 

1.0.0

 

@param

 

array $fields associative array of user input fields

 

@param

 

WC_Product $product the product

wc_memberships_for_teams_add_team_member_form_fields

Filters form fields for the add team member form on frontend.

@since

 

1.0.0

 

@param

 

array $fields associative array of form fields

wc_memberships_team_teams_area_sections

Filters the available sections for the teams area.

@since

 

1.0.0

 

@param

 

array $sections associative array with teams area id and label of each section

wc_memberships_for_teams_teams_area_{$section_id}_title

Filters the teams area section name title. Core section IDs include “members”, “add-member”, and “settings”.

@since

 

1.0.0

 

@param

 

string $section_name the section name (e.g. “Members”, “Add Member”, “Settings”…)

 

@param

 

Team $team the current team displayed

wc_memberships_for_teams_teams_area_my_team_details

Filters the teams area team details.

@since

 

1.0.0

 

@param

 

array $details associative array of settings labels and HTML content for each row

 

@param

 

Team $team the team the details are for

Frontend Actions

wc_memberships_for_teams_before_renewal_auto_login

Fires right before logging a team member in. Can throw SV_WC_Plugin_Exception to halt the login completely.

@since

 

1.0.0

 

@param

 

int $log_in_user_id the user ID of the member to log in

 

@param

 

SkyVergeWooCommerceMembershipsTeamsTeam $team team instance

 

@param

 

bool $allow_login whether automatic log in is allowed

Admin Hooks

This is a non-exhaustive list; these represent some often-used admin hooks.

Admin Filters

wc_memberships_for_teams_team_member_roles

Filters the list of available team member roles. Note that this does not include owner by design.

@since

 

1.0.0

 

@param

 

array $roles an associative array of role => label pairs

wc_memberships_for_teams_settings

Filters Memberships for Teams settings.

@since

 

1.0.0

 

@param

 

array $settings array of teams settings

wc_memberships_for_teams_invitation_statuses

Filters invitation statuses.

@since

 

1.0.0

 

@param

 

array $statuses associative array of statuses and their arguments

wc_memberships_for_teams_skip_invitations

Filters sending an invitation when adding members to a team

@since

 

1.1.2

 

@param

 

bool $skip_invitations whether invitations should be skipped

 

@param

 

null|SkyVergeWooCommerceMembershipsTeamsTeam optional argument to evaluate if invitations should be skipped for a particular team

 

@param

 

null|int|string|WP_User optional entity being invited to join a team (either email, ID or object)

wc_memberships_for_teams_team_membership_can_be_renewed

Filters whether a team membership can be renewed

@since

 

1.0.0

 

@param

 

bool $can_be_renewed whether can be renewed by a user

 

@param

 

SkyVergeWooCommerceMembershipsTeamsTeam $team the team to renew membership for

wc_memberships_for_teams_team_management_status

Filters team management status

@since

 

1.0.0

 

@param

 

array an associative array with two keys: “can_be_managed” and “messages”

 

@param

 

SkyVergeWooCommerceMembershipsTeamsTeam $team the related team

wc_memberships_for_teams_team_can_add_seats

Filters whether a team can have seats added

@since

 

1.1.0

 

@param

 

bool $can_add_seats whether seats can be added

 

@param

 

SkyVergeWooCommerceMembershipsTeamsTeam $this the Team object

wc_memberships_for_teams_team_can_remove_seats

Filters whether a team can have seats removed

@since

 

1.1.0

 

@param

 

bool $can_remove_seats whether seats can be removed

 

@param

 

SkyVergeWooCommerceMembershipsTeamsTeam $this the Team object

wc_memberships_for_teams_allow_editing_user_membership

Filters the editing of a user membership

@since

 

1.1.2

 

@param

 

bool $allow_edit default true for non-subscription linked memberships

 

@param

 

WC_Memberships_User_Membership|WC_Memberships_Integration_Subscriptions_User_Membership $user_membership membership object

wc_memberships_for_teams_should_perform_seat_change

Filters whether a seat change should be performed

@since

 

1.1.0

 

@param

 

bool $should_perform_seat_change

 

@param

 

SkyVergeWooCommerceMembershipsTeamsTeam $this the Team object

 

@param

 

int $new_seat_count the desired seat count

wc_memberships_for_teams_should_prorate_seat_change

Filters whether a seat change should be prorated

@since

 

1.1.0

 

@param

 

bool $should_prorate_seat_change default false

 

@param

 

SkyVergeWooCommerceMembershipsTeamsTeam $this the Team object

 

@param

 

int $new_seat_count the desired seat count

wc_memberships_for_teams_seat_change_notice_message

Filters the notice message that is shown after a successful seat change

@since

 

1.1.0

 

@param

 

string $seat_change_message the notice message

 

@param

 

WC_Order $order the order object

 

@param

 

WC_Order_Item $item the order item object that contains the seat change data

 

@param

 

SkyVergeWooCommerceMembershipsTeamsTeam $this the Team object

Admin Actions

wc_memberships_for_teams_before_team_billing_details

Fires before the billing details in edit team screen.

@since

 

1.0.0

 

@param

 

SkyVergeWooCommerceMembershipsTeamsTeam $team the team instance

wc_memberships_for_teams_after_team_billing_details

Fires before the billing details in edit team screen.

@since

 

1.0.0

 

@param

 

SkyVergeWooCommerceMembershipsTeamsTeam $team the team instance

Methods and Global Functions

This is a non-exhaustive list; these represent some often-used plugin methods.

Plugin main class

The instance of the main plugin class can be accessed with: wc_memberships_for_teams()

Any other plugin classes are instantiated in this main plugin class, or another class that’s instantiated by the main plugin class. Therefore, if you want to unhook methods in a particular class, you’ll need to use this helper to access the class instance. For example, many classes are instantiated by the main plugin class, and can be accessed with:

wc_memberships_for_teams()->get_*_instance()

For example:

wc_memberships_for_teams()->get_orders_instance()

Classes that are not instantiated in the main plugin class can be accessed through instances of the class that instantiates them:

wc_memberships_for_teams()->get_frontend_instance()->get_teams_area_instance()

Teams object

While we won’t list every method here, the Team object is a good one to review, as this provides methods to get or set almost any piece of team data, or programmatically process seat changes, member invites, adding or removing members, etc.

An instance of this class can be accessed with:

wc_memberships_for_teams_get_team( $team_id_or_post )

Conditional Checks

There are a few conditional checks that can help you determine team or product information.

wc_memberships_for_teams_is_valid_team_member_role( $role )

Checks if a team member role is valid or not.

@since

 

1.0.0

 

@param

 

string $role the role to check

SkyVergeWooCommerceMembershipsTeamsProduct::has_team_membership( $product )

Checks if a product has a team membership attached (purchasing this product creates a team). You must pass an instance of WC_Product to this method.

@since

 

1.0.0

 

@param

 

WC_Product $product

SkyVergeWooCommerceMembershipsTeamsProduct::has_per_member_pricing( $product )

Checks if a product uses per-member pricing (false if per-team pricing is used). You must pass an instance of WC_Product to this method.

@since

 

1.0.0

 

@param

 

WC_Product $product

Global & Static Functions

A non-exhaustive list of some helpful global and static methods for use in customizations.

SkyVergeWooCommerceMembershipsTeamsProduct::get_min_member_count( $product )

Gets the minimum member count required to purchase the team product; returns the integer count or null if not set. You must pass an instance of WC_Product to this method.

@since

 

1.0.0

 

@param

 

WC_Product $product

SkyVergeWooCommerceMembershipsTeamsProduct::get_max_member_count( $product )

Gets the maximum member count allowed when purchasing the team product; returns the integer count or null if not set. You must pass an instance of WC_Product to this method.

@since

 

1.0.0

 

@param

 

WC_Product $product

SkyVergeWooCommerceMembershipsTeamsProduct::get_membership_plan_id( $product )

Gets the membership plan ID that will be granted to a team created via this product; returns the integer count or null if not set. You must pass an instance of WC_Product to this method.

@since

 

1.0.0

 

@param

 

WC_Product $product

wc_memberships_for_teams_get_team( $id_or_post )

Can be used to get an instance of a team. Accepts the team post object or post ID. Returns a Team instance if found, or false on failure.

@since

 

1.0.0

 

@param

 

int|WP_Post $post optional team id or post object, defaults to current global post object

wc_memberships_for_teams_get_teams( $user_id, $args, $return, $force_refresh )

Returns a list of teams for a user (should be preferred over get_posts() calls to protect against data structure changes). Can return either a plain list of team objects or an associative array with query results and team objects, and will return false on failure.

@since

 

1.0.0

 

@param

 

int $user_id optional, defaults to current user

 

@param

 

array $args an array of arguments to pass to WP_Query – additionally, a few special arguments can be passed: {

• • @type string|array $status team status, defaults to ‘any’
  • @type string|array $role a comma-separated list or array of team member roles, defaults to ‘owner, manager’ – specifying this will only fetch teams that the user has one of the given roles
  • @type int $paged the page number for paging the results (corresponds to paged param for get_posts())

}

 

@param

 

string $return (optional) what to return – set to ‘query’ to return the WP_Query instance instead of a list of invitation instances

 

@param

 

bool $force_refresh (optional) whether to force reloading the results even if a previous result has been memoized, defaults to false

wc_memberships_for_teams_get_user_membership_team( $user_membership_id )

Returns the team for a given user membership, if any. Returns false if the membership does not belong to a team.

@since

 

1.0.0

 

@param

 

int $user_membership_id user membership id

wc_memberships_for_teams_get_team_members( $team_id, $args, $return, $null )

Returns a list of team members given the input query (should be preferred over get_posts() calls to protect against data structure changes). Can return either a plain list of team member objects or an associative array with query results and team member objects.

@since

 

1.0.0

 

@param

 

int|SkyVergeWooCommerceMembershipsTeamsTeam $team_id team id or instance to get the team members for

 

@param

 

array $args (optional) an array of arguments to pass to WP_Query – additionally, a few special arguments can be passed: {

• • @type string|array $role a comma-separated list or array of team member roles, empty by default – specifying this will only fetch members with the given role
  • @type int $paged the page number for paging the results, corresponds to paged param for get_users()
  • @type int $per_page the number of team members to fetch per page, corresponds to the number param for get_users()

}

 

@param

 

string $return (optional) what to return – set to ‘query’ to return the WP_User_Query instance instead of a list of team member instances

 

@param

 

bool $force_refresh (optional) whether to force reloading the results even if a previous result has been memoized, defaults to false

wc_memberships_for_teams_get_team_member_roles()

Returns a an associative array of available team member roles.

@since

 

1.0.0

wc_memberships_for_teams_create_team( $args )

Programmatically creates a team. Returns a new Team object on success which can then be used to add additional data, but will return SV_WC_Plugin_Exception on failure.

@since

 

1.0.0

 

@param

 

array $args (see below)

 

@param

 

string $action ‘create’ or ‘renew’; defaults to ‘create’

 

@return

 

Team|SV_WC_Plugin_Exception

The arguments you can pass in to create a new team are as follows:

wc_memberships_for_teams_create_invitation( $args )

Programmatically creates a team invitation. Returns a new Invitation object on success which can then be used to add additional data, but will throw SV_WC_Plugin_Exception on failure.

@since

 

1.0.0

 

@param

 

array $args (see below)

 

@return

 

Invitation|SV_WC_Plugin_Exception

The arguments you can pass in to create a new invitation are as follows:

wc_memberships_for_teams_get_invitation( $id, $email )

Returns a specific invitation for a team, or false on failure.

@since

 

1.0.0

 

@param

 

string|int|WP_Post|Invitation|Team $id invitation token, id, or instance; or team id or instance

 

@param

 

string $email (optional) invitation recipient email, required if $id is a team id or instance

wc_memberships_for_teams_get_invitations( $team_id, $args, $return, $force_refresh )

Returns a list of invitations (should be preferred over get_posts() calls to protect against data structure changes). Can return either a plain list of invitation objects or an associative array with query results and invitation objects.

@since

 

1.0.0

 

@param

 

int $team_id team id to get the invitations for

 

@param

 

array $args an array of arguments to pass to WP_Query – additionally, a few special arguments can be passed: {

• • @type string|array $status invitation status, defaults to ‘pending’, can be used instead of $post_status
  • string|array $role a comma-separated list or array of team member roles, empty by default – specifying this will only fetch invitations that grant the one of thge specified roles for the user
  • @type int $paged the page number for paging the results, corresponds to paged param for get_posts()
  • @type int $per_page the number of invitations to fetch per page, corresponds to the posts_per_page param for get_posts()

}

 

@param

 

@param string $return (optional) what to return – set to ‘query’ to return the WP_Query instance instead of a list of invitation instances

 

@param

 

bool $force_refresh (optional) whether to force reloading the results even if a previous result has been memoized, defaults to false

User Documentation

The post Teams for WooCommerce Memberships Developer Documentation first appeared on CODIBU.

MailChimp for WooCommerce Memberships gives you the ability to sync your members from WooCommerce Memberships to a MailChimp list of your choice.

When you connect your site to MailChimp, this plugin will ensure all member data remains synced to MailChimp, letting you segment your mailing list by membership type, status, and more!

Installation

1. Download the extension from your WooCommerce dashboard
2. Ensure your store meets the plugin requirements.
3. Go to Plugins > Add New > Upload and select the ZIP file you just downloaded
4. Click Install Now, and then Activate
5. Click the Configure link, or go to WooCommerce > Memberships, and read the next section to learn how to setup and configure the plugin.

Requirements

• WooCommerce 2.6.14 or newer
• WordPress 4.6 or newer
• PHP 5.3 or newer (you can see this under WooCommerce > Status)
• WooCommerce Memberships 1.9.0 or newer

Setup & Configuration

Settings for this plugin can be found under WooCommerce > Settings > Memberships > MailChimp Sync. Here, you’ll enter your API key for your MailChimp account, then configure how member data should be tied to MailChimp.

Get MailChimp API key

First, we need to get your API key from your MailChimp account, as this will let the plugin pull in data about your lists. You can find this by clicking “Account” from your menu while logged in.

Next, click “Extras”, then API Keys, to view any API keys for your account, or create new ones.

Finally, if you have an API key already, you can use your existing key, or generate a new one (we recommend using a new key). Then, copy this key.

Paste your API key into the plugin settings, and save your settings. You’ll then be able to configure plugin settings with access to your MailChimp lists and merge tags.

Extension settings

Under WooCommerce > Settings > Memberships > MailChimp Sync, once you’ve saved a valid API key, you’ll now see data related to your MailChimp account.

The first thing to do is to select the list your members should be synced to, and save your settings. When you’ve selected your list, the plugin will automatically push new merge tags to your MailChimp Account. You’ll have one merge tag per plan, along with an ISACTIVE merge tag.

You can now map merge tags to your existing membership plans. You can use the tags the plugin has created for you, or select merge tags of your own (in case you’ve already had member data present in MailChimp).

To see more details on what each merge tag represents, please view our notes on MailChimp segments. These merge tags are automatically updated every time a membership is changed to ensure that status and member data are always up-to-date in MailChimp.

Other settings

• Enable Debug Mode – enable if you experience issues with your MailChimp connection; as a best practice, this should be disabled unless actively troubleshooting.
• Members Sign up – Determine if members are signed up for your list automatically, or if they must opt into your list. Please see our overview below on whether or not opt in is required.
• Members Signup Prompt Text – Enter the text to use for opt in at checkout and from the members area if a member has not opted into your list.
• Members Signup Button Text – Enter the call to action text for the members area opt in.

Finally, you can configure some general settings for how to handle certain membership events.

• Deleted memberships – Determine whether deleting a user membership unsubscribes the member from your list, or removes the member from your list. If the member has more than one membership, the member will only be removed or unsubscribed if all memberships have been deleted (though merge tags will still be updated to reflect accurate membership data).
• Deleted plan merge fields – Determine what to do with plan merge tags if a plan is deleted. You can keep existing merge tags in MailChimp, or delete those merge tags when plans are deleted.
• Sync members – This action forces a member sync with MailChimp — helpful if you’ve just installed, or had your site in maintenance mode and need to update membership records.

MailChimp usage

Do I need consent to add members to my list?

This depends entirely on what kind of emails you’ll be sending to this list. Are you sending emails related to the membership perks and content available? Or related to the lifecycle of this person’s membership? If your emails are for the purpose of fulfilling a contractual obligation, legal obligation, or for a legitimate business interest, you likely do not need consent. Jilt has a great overview of the GDPR and email marketing that we’d recommend reading in order to determine how your own business should comply with privacy regulations like the GDPR and PECR.

MailChimp segments

As changes happen to membership data on your site, these changes are automatically synced with MailChimp so your subscriber data is always updated. The following events will update your subscriber data in MailChimp:

In short, you’ll always have a plan merge tag updated with the current membership status (such as “active”, “pending”, “expired”, etc), as well as an ISACTIVE merge tag that is updated to reflect whether the subscriber has any active membership on your site (will always be “yes” or “no”).

This helps you create segments in MailChimp so you can target emails to particular members, all members, or members with specific statuses.

MailChimp only allows for up to 5 segmentation conditions, so the ISACTIVE tag can be very handy to target multiple plans at once.

Here are a couple general rules to help you create segments:

• The ISACTIVE merge tag will be empty if the subscriber has no membership records on your site. It will be “yes” if they have any active memberships, and “no” if they have had memberships that have since become inactive.
• The plan-specific merge tags will always have the current status as the value of the merge tag (here’s a quick reference list). The plan-specific merge tag will be empty if the subscriber has no memberships for that plan (active or inactive).

Admin Usage

For the most part, you’ll never have to push a member sync to MailChimp after set up, as the plugin will do this automatically. Once you’ve set up your list and merge tags, we do recommend using the “Sync now” action in settings to push your membership data to MailChimp.

If you find that you want to force data to update at any time, you can do so from the plugin settings, or from your “Members” list via bulk action or single membership action.

Your plans list will also have merge tags displayed for quick reference if you’re building segments.

Note that merge tags are not editable from the plan view; they can only be edited via plugin settings. We do not recommend changing merge tags once you’ve started syncing members. If you do, please perform a full sync from the plugin settings so MailChimp data is accurate.

Customer experience

For most stores, customers will not see anything on the frontend of your site while using this plugin. However, if you’ve enabled opt-in for members (after reviewing our notes on privacy / opt-in), then your customers will see opt-in prompts in two locations:

At checkout while purchasing a membership as a guest, or while logged in as a member:

In the members area of their account if they haven’t opted in:

Members can unsubscribe from your emails when sent.

Frequently Asked Questions

Q: Can I remain GDPR-compliant while adding members to my list?
A: Yes! It depends on the basis you have for sending those emails, and what kind of emails you’re sending. Please review our notes on privacy to determine what’s best for your site.

As for personal data erasure requests, these are handled by the main memberships plugin, along with your settings for deleted memberships. Please review the Memberships privacy details for further information.

Q: What will happen if I delete or expire a membership, but the customer still has other active memberships on my site?
A: When there’s a change to expire or remove one membership, other memberships are also checked before pushing data to MailChimp. In this case, since the customer has other active memberships, they won’t be removed or unsubscribed, and your “Is active” merge tag will remain “yes”. The membership being deleted will have its plan merge tag cleared in this case only to reflect there is no longer member data for that plan.

Q: I have a lot of plans, and I want to target active members of some of them, but I don’t have enough segmentation conditions. How can I do this?
A: Unfortunately you may be limited by the segmentation options within MailChimp if you have several plans you want to target in a segment. When this happens, we recommend creating a segment for each plan, then duplicating your campaigns to segment for different plans with the same content so you can reach your intended audience.

Troubleshooting

Having difficulty with the plugin? Please ensure your site meets the plugin requirements, and if so, get in touch with the support team for assistance.

The post MailChimp for WooCommerce Memberships first appeared on CODIBU.

Teams for WooCommerce Memberships lets you sell memberships to groups of people, such as companies, organizations, and classes. When you sell a team membership, the team owner is responsible for team maintenance (such as adding members and managing billing), while members enjoy all the benefits associated with the membership plan.

Installation

1. Ensure your store meets the plugin requirements.
2. Download the extension from your WooCommerce dashboard.
3. Go to Plugins > Add New > Upload and select the ZIP file you just downloaded.
4. Click Install Now and then Activate.
5. Click Configure and read the next section to learn how to setup the plugin.

Requirements

At a minimum, your site must meet the following requirements to use Teams for Memberships:

• WooCommerce 3.0.4 or newer
• WordPress 4.6 or newer
• PHP 5.3 or newer (you can see this under WooCommerce > Status)
• WooCommerce Memberships 1.9.4 or newer

Translations

This plugin is translation-ready under the following text domain:

woocommerce-memberships-for-teams

Click here for guidelines on translating extensions.

Getting Started

Settings

You can find the following Teams for Memberships settings under WooCommerce > Settings > Memberships > Teams:

• Teams are called: If you’d like to use a different term instead of “team” and “teams” (e.g., club / clubs, family / families, etc.), you may update these fields with your desired terms.
• Allow removing members: Check to let team owners and managers remove members from their teams.
• Owners must be members: Check to require that team owners take up a seat on their teams.
• Allow managers to add or remove other managers: Check to let managers add or remove other managers from the team. Team owners are always allowed to add and remove managers. Click here to learn more about team roles.

The Teams for Memberships endpoint settings for team account management are found under WooCommerce > Settings > Advanced in the Account endpoints section:

Creating Team Membership Products

You must create a team membership product to let customers purchase a team membership. Team membership products require special configuration to detail the size, price, and plan access associated with the team.

Follow the steps below to create a team membership product:

1. Go to Products and click Add New.
2. Under the Product Data section, set the product type. You can use simple/variable products or simple/variable subscriptions for a team membership product.
3. Check the Team Membership box. This will expose new fields related to team pricing, size, and membership plan:
   • Team Pricing: Should the team be priced per-member or per-team?
   • Price: The per-team or per-member price.
   • Sale price: (Optional) The per-team or per-member sale price.
   • Minimum member count: For per-member priced teams, the minimum number of members required to purchase a team. Leave blank to enforce no minimum member count.
   • Maximum member count: The maximum number of members allowed on the team. Leave blank to allow unlimited seats.
   • Team members will have access to: Select the membership plan that members of this team will be assigned to.

   

   If you are working with a variable product or variable subscription, these settings can be largely controlled from the individual variations:

   

4. Populate any other details for the product and its variations, if applicable, as desired.

As an administrator, you can view the products and variations required to purchase a team membership from the associated membership plan’s page under WooCommerce > Memberships > Membership Plans:

However, please note that due to the additional settings associated with team membership products (such as team pricing and size requirements), you can’t add or remove team products from this area. All other settings associated with the membership, such as its length, content, discounts, etc. are configured on this page as with an individual membership.

If team access is sold via a simple or variable product, team members will have access to the membership plan for the plan length. For example, suppose a team was purchased on January 1 for a plan that grants access for 1 year. If a member is added to the team on February 1, the member has access until February 1 of the follow year. Once the user membership ends, the membership is over unless the team is renewed.

Team Roles

There are three roles for the users associated with a team – owners, managers, and members:

Creating, Joining, and Managing Teams as a Customer

When a customer purchases a team, they become the team owner and are responsible for managing the team and its members.

Purchasing Teams

Purchasing a team membership product is similar to purchasing any other product, with a few extra steps:

• Team Name: The owner must enter a name for their team. This can be changed later by the team owner or the site administrator.
• Take up a seat: Unless you require owners to take up a seat on the team, owners can choose whether or not they will be a team member as well as an owner. If a team owner is also a team member, they can access all content, products, and discounts associated with the membership plan. If a team owner is not a team member, they can manage the team but can’t take advantage of the membership plan benefits.
• Number of Seats: For a per-member priced team, the owner must include the number of seats they’re purchasing for their team. Team minimum and maximum seat counts, if applicable, will be enforced.

As with all memberships, the team owner must create an account before or during the checkout process when purchasing a team membership so they can manage the team from their My Account area.

Inviting Members

Owners and managers can add members to their team by going to My Account > Teams > Add Member. From this page, the owner or manager can add users to the team in two ways:

• Registration Link: Any user that clicks this link can register for the team. The owner or manager can regenerate the link to deactivate the previous link. This method is quick and easy, but less secure.
• Add Member: The owner or manager can enter the user’s email and role to add members to the team individually. This method is secure, but requires more manual work.

The owner or manager can view pending invitations by going to My Account > Teams > Members > Pending invitations. From this page, the owner or manager can resend the invitation, cancel the invitation, or change the new user’s role.

Once a user is invited to a team or selects the Registration Link, they can register for an account (if they haven’t already done so) and join the team. The process varies for new users and existing users, but everyone must have an account on your site before they can join the team.

If the invitation was sent to email A, but the user has an account on your site under email B, they can choose to either join the team under email B or create a new account for email A.

When a member joins a team, they can access all the benefits and content associated with the team’s membership plan. Members can view the membership perks from the member area, if enabled, under My Account > Memberships. From the members’s perspective, the only difference between an individual membership and being a member of a team is that the team member has no control over billing or renewals – that’s all managed by the team owner.

Managing Members

If Teams for Memberships settings allow owners and managers to remove members, they can do so by going to My Account > Teams > Members and selecting the Remove button. They can also change the role assigned to users from this page.

Members can also choose to leave the team by going to My Account > Memberships > Manage > Leave Team, but they will lose access to the membership perks at that point.

Adding Seats to a Team

After a team is purchased, the team owner may want to adjust the number of seats on the team. Team owners can add seats to teams that are:

• Active
• Associated with a product
• Under the maximum allowed seat count
• For per-team priced teams, limited in seat count – there’s no need to add seats to unlimited teams! 

For teams that meet these conditions, owners can add seats by following the steps below:

1. Go to My Account > Teams > Team Settings.
2. Click Add Seats.
3. Enter the number of seats you want to add to the team. For per-team priced teams, enter the number of blocks of seats you want to add. A block of seats is equal to the team’s maximum seat count.
4. Click Submit.

The team owner will be directed to a checkout page to pay for the new seat(s). For per-member priced teams, the owner will be charged according to the per-member price for that team product. For per-team priced teams, the owner will be charged the team price for the new block of seats.

Managing Billing

If the team membership expires, the team owner can renew the membership by going to My Account > Teams > Team Settings and selecting Renew. The team owner will then go through a checkout process for the new membership.

Managing Teams as an Administrator

You can view all the teams on your site from WooCommerce > Memberships > Teams. From here, you can view, filter, add, edit, and delete teams.

You can also view team memberships from the WooCommerce > Memberships > Members page. From this page, you can see the team associated with the membership and the user role’s within the team, if applicable. You can also search by teams or filter the list of members to exclude team members.

When editing a team member from this page, you’ll see a notice that recommends editing the team membership instead of the membership access for the team members. This is because editing the membership of a team member directly (instead of initiating that change from the team settings) can cause problems with that member’s access. For example, changing the expiration date for a team member’s access will place that member out of sync with the rest of the team’s access to membership content and perks.

Adding Existing Members to a Team

If you want add existing members to a team, you can manually create and move their memberships under a team by following the below steps:

1. Go to WooCommerce > Memberships > Teams and click Add New.
2. Set the team name. The team owner can change the team name later.
3. In the Team Details section, set the owner and other team settings.
4. In the Billing Details section, you can designate the team membership product, which is important if you want owners to be able to renew the team’s access.
5. Click Update.

The team owner can now manage the team from their account. You can advise the owner to share the Registration Link to invite members to their new team. When the members select this link and join the team, their existing membership will move under the team’s management and billing.

Exporting Team Data

You can use the WooCommerce Memberships export to retrieve the following Teams for Memberships information:

• Team ID
• Team Slug
• Team Name
• Team Role

Please note that these fields are read-only – you cannot update Teams for Memberships information via an import at this time. If updating teams via import is important feature for you, please let us know.

Teams for Memberships and WooCommerce Subscriptions

When you use Teams for Memberships with WooCommerce Subscriptions, you can sell team access with recurring billing. Before getting started, please review our documentation on the integration between WooCommerce Memberships and WooCommerce Subscriptions.

In general, subscription-tied teams are similar to regular teams. When a team is tied to a subscription, all team user memberships follow the subscription record. If the subscription is paused or cancelled, the user memberships will also be paused or cancelled. If the team is unlinked from the subscription, all the team user memberships will be unlinked from the subscription, too.

Creating Team Subscription Products

Creating a team subscription product is very similar to creating a standard team membership product. You can use simple or variable subscriptions to sell access to team memberships. When using per-member pricing for the team, all subscription fees (including sign-up fees, if applicable) are multiplied by the seat count.

The team subscription product will appear when editing the membership plan from WooCommerce > Memberships > Membership Plans. You can set the subscription-tied membership length from this page, which will also apply to any individual subscription-tied memberships under this plan. Click here to read more about subscription-tied membership length.

Adding Existing Members to a Subscription-tied Team

To add existing members to a subscription-tied team, you can manually create the team, link it to the subscription, and move their memberships under the team by following the below steps:

1. Manually create the subscription

First, you’ll need to manually create the subscription for the team owner. Click here for instructions on manually creating subscriptions. If you’re creating a per-member priced team, be sure that the subscription quantity and price correspond to your desired number of seats!

2. Manually create the team

Follow the steps below to create the team in the admin area:

1. Go to WooCommerce > Memberships > Teams and click Add New.
2. Set the team name and Team Details, such as owner and seat count.
3. Click Update.

3. Link the team to the subscription

Follow the steps below to link the manually created subscription and team:

1. In the team you just created, check the URL bar to get the team ID and copy it to your clipboard.
2. Go to WooCommerce > Subscriptions and open the manually created subscription.
3. Click the pencil icon for the team membership product item.
4. Click Add Meta.
5. Enter _wc_memberships_for_teams_team_id as the meta key Name and the team ID (copied to your clipboard!) as the Value.
6. Click Add Meta.
7. Enter team_name as the meta key Name and the team name as the Value.
8. Click Save.

4. Update team details

Now, you’ll need to update the team details by following these steps:

1. Go to WooCommerce > Memberships > Teams and open the team.
2. Under the Billing Details section, link the team membership product and the subscription.
3. Click Update.

5. Invite members

The team owner can now manage the team from their account. If the owner should take up a seat on the team, you can add them to the team at this stage. If you want to leave that up to the owner, they can add themselves to the team.

You can advise the owner to invite members to their new team by sharing the Registration Link. When the members select this link and join the team, their existing membership will move under the team’s management and billing. Once members migrate to the team, you’ll need to cancel their existing member subscriptions so the owner can manage all billing.

Changing the Seat Count on a Subscription-tied Team

Team owners can add or remove seats from their subscription-tied team. The impact on billing varies based on whether the owner is adding or removing seats and how the team is priced – per-team or per-member.

Adding or Removing Seats on a Per-Member Priced Team

The team owner can follow the steps below to change the number of seats on their team:

1. Go to My Account > Teams > Team Settings and click Change Seats.
2. Enter the new seat count.
3. Click Submit.

If the owner is adding seats, they will go through the checkout process to pay for the new seat’s immediate access and to update the recurring total going forward. The initial charge will be prorated to account for the time remaining in the current billing cycle to ensure the owner is charged fairly for the new seats.

For example, if a subscription charges $10/member/month and the team is halfway through the billing cycle when a seat is added, the owner will initally pay $5 for that seat. When the team renews at the end of the month, the new seat will be charged $10 for renewal, like all other seats on the team.

If the owner is removing seats, the recurring total will be reduced to account for the lost seats. However, the owner will not be reimbursed for any unused time on the current billing cycle for those seats. The new recurring total will apply to the next renewal payment.

Adding Seats on a Per-Team Priced Team

All seat additions on a per-team priced team are made in a block equal to the team’s maximum seat count. For example, if a team permits up to 10 seats, you can add seats in 10-seat blocks. Adding seats for a per-team priced team is essentially like purchasing a new team and bringing it under the current team’s management. You cannot remove seats from a per-team priced team.

The owner can follow the steps below to add seats to their team:

1. Go to My Account > Teams > Team Settings and click Add Seats.
2. Enter the number of blocks you want to add to the team.
3. Click Submit.

Frequently Asked Questions

Q: Can team owners change the name of their team?
A: Yes – team owners can change the name of their team from My Account > Teams > Team Settings.

Q: Will team members get renewal emails for their memberships?
A: No – individual team members won’t get their own renewal or expiration emails because they can’t act upon them. The team owner alone is responsible for managing billing and renewals, so they will receive all renewal and expiration emails.

Q: Can team owners add or remove seats from their team?
A: Yes! Team owners can change the seat count on their team, though this varies based on the type of team and how it is priced. Click here to read about changing seats.

Q: Can I provide quantity discounts for increasing the number of members?
A: Sure thing! For a stepped approach (e.g., price breaks at 5 members, 10 members, 15 members, etc.), you can use variable products to create tiered discounts. You can also use Dynamic Pricing to discount the per-member or per-team price based on the number of seats or teams selected.

Q: Can I move existing user memberships into a team so they’re managed by one person?
A: Sure! Click here to learn more about adding existing members to a team.

Q: Can I make the membership plan length longer or shorter for team members than for individual members?
A: No – at this time, members share the same plan length, regardless of team affiliation. If you’d like to set different access periods for team members vs individual members, you’ll need to setup two different plans. You can duplicate a plan to assist with set up! Please let us know if this feature is important to you.

Q: What happens if a team purchase is refunded?
A: For a full refund, all memberships on the team are cancelled. This means that the team owner and managers can’t add any new members to the team. For a partial refund, you can adjust the team seats and cancel members manually as needed.

Q: What happens if the team owner stops the subscription?
A: For subscription-tied teams, changes in the subscription status are inherited by all members of the team. If the subscription is paused, all team memberships are paused. If the subscription is cancelled, all team memberships are cancelled as well.

Q: How long do team members have access to membership perks?
A: This depends on the team billing:

• If the team is tied to a regular product, then members have access for the full membership period. If the membership should last one year, each user’s membership runs for a year, regardless of when they started.
• If the team is tied to a subscription product, then this depends on your plan settings. If the subscription has a set-length, the user memberships will act like regular memberships. If the team follows the subscription length, the team memberships last until the subscription ends or is cancelled.

Q: One or more of my team owners renewed their team for $0, and I saw an admin notice that says this was due to a plugin bug. How can I ensure this team owner pays for their access?
A: First, we are so sorry about this issue. While it only impacts a small number of teams – only teams with per-team pricing and unlimited seats – we regret any frustration caused by this issue. At this point, you can choose to do nothing and your future renewals will be charged appropriately, or you can end the affected team memberships to force the team owner to renew now by following these steps:

1. Go to WooCommerce > Memberships > Teams and look for any teams with unlimited seats in your teams list.
2. View the team’s most recent renewal under the Billing Details to see if the renewal processed for $0.
3. Change the Team memberships begin to expire field to today and click Update.

If you have any questions about this process or need assistance locating affected teams, please contact our support team. We would be happy to help make this right.

Troubleshooting

Having difficulty with the plugin?

• Please ensure your site meets the plugin requirements.
• If you’re experiencing issues migrating existing memberships or subscriptions into a team structure, please review our guide for adding existing members to teams or manually adding existing members to subscription-tied teams.
• If you’re experiencing a different issue, please get in touch with the support team for assistance.

The post Teams for WooCommerce Memberships first appeared on CODIBU.