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.

You can manage WooCommerce Memberships plans and members via WP CLI if installed in your environment. There are two additional subcommands added to the WC CLI implementation: user_membership and membership_plan.

For further details please see the CLI help topics: wp help wc user_membership and wp help wc membership_plan.

All versions can still use our legacy WP CLI implementation too. This will allow you to use the primary command of wp wc memberships followed by our sub-commands:

• memberships – manage user memberships
• plan – manage membership plans

If you are looking to create and edit membership plans, then you will need to use the legacy CLI for the time being. You can also use wp help wc memberships for additional information and in-context help.

wp wc membership_plan

You can read plans with the wp wc membership_plan subcommands:

wp wc membership_plan get

Get data associated with a membership plan by ID:
wp wc membership_plan get 123

Get plan examples

wp wc membership_plan get 246

Gets all fields for plan 246

wp wc membership_plan get 343 --fields="id,slug,type,length,members_count"

Gets a selection of fields for plan 343

wp wc membership_plan get 8761 --format="json"

Gets plan data for membership plan 8761 in JSON formation

wp wc membership_plan list

Lists data associated with membership plans:
wp wc membership_plan list

Plan list examples

wp wc membership_plan list

Outputs a table of default data for all plans

wp wc membership_plan list --format="csv"

Provides a CSV formatted result of all membership plans

wp wc membership_plan list --fields="slug,members_count"

Outputs a list of plans with only the slug and member count.

wp wc user_membership

You can manage user memberships with wp wc user_membership subcommands:

wp wc user_membership create

Allows you to create new user membership.

User Membership creation examples

wp wc user_membership create --customer_id=83 --plan_id=238

Creates an unlimited membership for user 83 to plan 238

wp wc user_membership create --customer_id=101 --plan_id="silver" --start_date_gmt="2016-01-01" --end_date_gmt="2016-06-30" --status="expired"

Creates an expired silver membership for user 101 that started on Jan 1, 2016, and ended on June 30, 2016

wp wc user_membership delete

Deletes a user membership using ID:
wp wc user_membership delete 101

You can also delete all members at once:
wp wc user_membership delete $(wp wc user_membership list --format=ids)

wp wc user_membership update

Allows you to update user memberships using the user membership ID:
wp wc user_membership update 9809

User Membership update examples

wp wc user_membership update 8762 --end_date_gmt="2017-01-01" --status="active"

Updates the end date and status of user membership 8762

wp wc user_membership update 776 --plan_id=126

Changes user membership 776 to use plan 126

wp wc user_membership get

Get data associated with a user membership by ID:
wp wc user_membership get 653

Get user membership examples

wp wc user_membership get 848

Gets all fields for user membership 848

wp wc user_membership get 848 --fields="plan,status"

Gets the plan and status for user membership 848

wp wc user_membership get 848 --format="json"

Gets data for user membership 848 in JSON formation

wp wc user_membership list

Lists data associated with all user memberships:
wp wc user_membership list

User Membership list examples

wp wc user_membership list

Outputs a table of default data for all memberships

wp wc user_membership list --format="csv"

Provides a CSV formatted result of all user memberships

wp wc user_membership list --fields="plan_id, status"

Outputs a list of memberships with only the plan ID and membership status.

wp wc user_membership import

Import a csv file of user_memberships to be created or merged:
wp wc user_membership import user_memberships.csv

Legacy CLI

Versions prior to 1.13.0 can still use our legacy WP CLI implementation. We would recommend updating any command line tooling to the updated WC REST API implementation where possible, as the following commands are now considered deprecated and will be removed at a later date.

wp wc memberships plan

You can manage plans with wp wc memberships plan subcommands:

wp wc memberships plan create

Allows you to create new membership plans.

Plan create examples

wp wc memberships plan create --name="Gold Membership"

Creates an admin-assign only, unlimited plan named “Gold Membership”

wp wc memberships plan create --name="Silver" --slug="silver-plan" --length="1 month" --product=123,456,6780

Create a “Silver” plan that lasts 1 month, and grants access via purchase of products 123, 456, or 6780

wp wc memberships plan create --name="Bronze Plan" --start_date="2017-10-01" --end_date="2018-08-25"

Create a “Bronze Plan” that is accessed via admin assign only, and runs from Oct 1, 2017 to August 25, 2018

wp wc memberships plan create --name="Free Plan" --access="free"

Create a “Free Plan” that grants access upon registration and is unlimited in length.

wp wc memberships plan delete

Deletes a membership plan using ID:
wp wc memberships plan delete 123

You can also delete all plans at once:
wp wc memberships plan delete $(wp wc memberships plan list --format=ids)

wp wc memberships plan update

Allows you to update membership plans using the plan ID:
wp wc memberships plan update 123

Plan update examples

wp wc memberships plan update 987 --name="New Name"

Updates the plan name of membership plan 987

wp wc memberships plan update 8762 --start_date="2016-01-01" --end_date="2016-12-31"

Updates the start and end dates of plan 8762

wp wc memberships plan update 333 --access="signup"

Changes plan 333 to grant access at registration

wp wc memberships plan get

Get data associated with a membership plan by ID:
wp wc memberships plan get 123

Get plan examples

wp wc memberships plan get 246

Gets all fields for plan 246

wp wc memberships plan get 343 --fields="id,slug,type,length,members_count"

Gets a selection of fields for plan 343

wp wc memberships plan get 8761 --format="json"

Gets plan data for membership plan 8761 in JSON formation

wp wc memberships plan list

Lists data associated with membership plans:
wp wc memberships plan list

Plan list examples

wp wc memberships plan list

Outputs a table of default data for all plans

wp wc memberships plan list --format="csv"

Provides a CSV formatted result of all membership plans

wp wc memberships plan list --fields="slug,members_count"

Outputs a list of plans with only the slug and member count.

wp wc memberships membership

You can manage user memberships with wp wc memberships membership subcommands:

wp wc memberships membership create

Allows you to create new user membership.

Membership creation examples

wp wc memberships membership create --customer=83 --plan=238

Creates an unlimited membership for user 83 to plan 238

wp wc memberships membership create --customer=101 --plan="silver" --start_date="2016-01-01" --end_date="2016-06-30" --status="expired"

Creates an expired silver membership for user 101 that started on Jan 1, 2016, and ended on June 30, 2016

wp wc memberships membership delete

Deletes a user membership using ID:
wp wc memberships membership delete 101

You can also delete all members at once:
wp wc memberships membership delete $(wp wc memberships membership list --format=ids)

wp wc memberships membership update

Allows you to update user memberships using the user membership ID:
wp wc memberships membership update 9809

Membership update examples

wp wc memberships membership update 232 --customer=876

Transfers user membership 232 to user 876

wp wc memberships membership update 8762 --end_date="2017-01-01" --status="active"

Updates the end date and status of user membership 8762

wp wc memberships membership update 776 --plan=126

Changes user membership 776 to use plan 126

wp wc memberships membership get

Get data associated with a user membership by ID:
wp wc memberships membership get 653

Get membership examples

wp wc memberships membership get 848

Gets all fields for user membership 848

wp wc memberships membership get 848 --fields="plan,status"

Gets the plan and status for user membership 848

wp wc memberships membership get 848 --format="json"

Gets data for user membership 848 in JSON formation

wp wc memberships membership list

Lists data associated with all user memberships:
wp wc memberships membership list

User membership list examples

wp wc memberships memberships list

Outputs a table of default data for all memberships

wp wc memberships memberships list --format="csv"

Provides a CSV formatted result of all user memberships

wp wc memberships memberships list --fields="plan_id, status"

Outputs a list of memberships with only the plan ID and membership status.

CLI Extensions

Here’s a helpful community plugin to replicate the CSV Import functionality of Memberships via the command line. This is a nifty tool for developers to allow them to import memberships via the command line without timeouts, helpful for large data sets.

Questions & Support

Looking for questions or support? You can submit a request right from your account

The post WooCommerce Memberships – CLI Reference first appeared on CODIBU.

For Developers: Admin Hook Reference

WooCommerce Memberships is extremely extensible and offers ample actions and filters for developers to customize it as needed. If a hook doesn’t exist where you think it should, please submit a ticket so we can consider its addition.

This hook reference includes some of the actions and filters developers may find useful while customizing the plugin, but is not an exhaustive reference of all plugin hooks. Inline docs include parameters and returned values for more detail — the appropriate file for each hook is listed so you can refer to it.

Filters: Membership Access

wc_memberships_access_granting_purchased_product_id

@since

 

1.0.0

 

@param

 

int $product_id the ID that’s used for access

 

@param

 

array $access_granting_product_ids Array of product IDs that can grant access to this plan

 

@param

 

WC_Memberships_Membership_Plan $plan Membership plan access will be granted to

 

@return

 

int – the new product ID to use

Multiple products from a single order can grant access to a membership plan. Default behavior is to use the first product that grants access, but this can be overridden using this filter.

wc_memberships_grant_access_from_new_purchase

@since

 

1.3.5

 

@param

 

bool $grant_access true by default

 

@param

 

array $args {

 

• • @type int|string $user_id user ID for order
  • @type int|string $product_id product ID that grants access
  • @type int|string $order_id order ID

}

Filters whether membership access should be granted from the current purchase or not. Default behavior is to always grant access if a membership product is purchased.

Examples:

• Disable granting access if the customer already holds any membership
• Disable granting access if the customer already holds an active membership

wc_memberships_plan_grants_access_while_subscription_active

@since

 

1.6.0

 

@param

 

bool $grants_access Default: true

 

@param

 

int $plan_id Membership Plan ID

Filter whether a plan grants access to a membership while subscription is active.

wc_memberships_grant_access_from_existing_purchase_order_statuses

@since

 

1.0.0

 

@param

 

array $valid_order_statuses_for_grant array of order statuses

 

@param

 

object $plan the associated membership plan object

 

@return

 

array – the updated array of status

Filter the array of valid order statuses that grant access from previous purchases when the admin uses the “grant previous purchases access” action. Defaults to ‘processing’ and ‘completed’.

Example to add “Shipped” and “Invoice Paid” orders (You could also use these statuses for access during the purchasing cycle in addition to processing and completed orders, which the second function covers):

<?php // only copy this line if needed
/**
 * Membership access is already granted when orders are processing or completed
 * Add membership access for custom order statuses as well
 *
 * Example: grant membership access for "Shipped" and "Invoice Paid" orders during purchase cycle as well
 * Use the appropriate action for your custom order status
 */
function sv_wc_memberships_grant_access_for_custom_order_statuses() {

        // bail if Memberships is not active
        if ( function_exists( 'wc_memberships' ) ) {
                add_action( 'woocommerce_order_status_shipped', array( wc_memberships()->get_plans_instance(), 'grant_access_to_membership_from_order' ), 11 );
                add_action( 'woocommerce_order_status_invoice-paid', array( wc_memberships()->get_plans_instance(), 'grant_access_to_membership_from_order' ), 11 );
        }
}
add_action( 'init', 'sv_wc_memberships_grant_access_for_custom_order_statuses', 15 );
/**
 * Include custom order statuses in the plan "Grant Access" action to
 * create new memberships as well
 *
 * Example: include "Shipped" and "Invoice Paid Orders" in "Grant Access" action for memberships
 * @param array $statuses orders statuses to create memberships for in "Grant access" action
 * @param object $plan the associated membership plan object
 * @return array $statuses the updated array of statuses for which to grant access
 */
function sv_wc_memberships_add_grant_access_order_statuses( $statuses, $plan ) {

        // Grant membership access to "Shipped" and "Invoice Paid" orders as well
        // when "Grant Access" action is used
        $statuses = array_merge( $statuses, array( 'shipped', 'invoice-paid' ) );
        return $statuses;
}
add_filter( 'wc_memberships_grant_access_from_existing_purchase_order_statuses', 'sv_wc_memberships_add_grant_access_order_statuses', 10, 2 );

wc_memberships_allow_cumulative_member_discounts

@since

 

1.7.0

 

@param

 

bool $cumulative true if discounts should stack across plans

 

@param

 

int $member_id ID for the member / WP user

 

@param

 

WC_Product $product

Filters whether discounts should stack if a member has more than one member discount for a product. Return false to disable stacking:

add_filter( 'wc_memberships_allow_cumulative_member_discounts', '__return_false' );

Filters: Membership Statuses

wc_memberships_user_membership_statuses

@since

 

1.0.0

 

@param

 

array $statuses Associative array of statuses

 

@return

 

array – updated status array

Passes in an associative array of all user membership statuses, which can be used to add custom user membership statuses.

Example to add new statuses:

<?php // only copy this line if needed
/**
 * Add custom user membership statuses
 *
 * @param array $statuses the array of membership statuses
 * @return array $statuses the updated status array
 */
function sv_wc_memberships_add_membership_statuses( $statuses ) {

        $new_statuses = array(
                'wcm-refunded' => array(
                        'label'       => 'Refunded',
                        'label_count' => _n_noop( 'Refunded <span class="count">(%s)</span>', 'Refunded <span class="count">(%s)</span>' ),
                ),

                'wcm-some-status' => array(
                        'label'       => 'Another Status',
                        'label_count' => _n_noop( 'SomeStatus <span class="count">(%s)</span>', 'SomeStatus <span class="count">(%s)</span>' ),
                ),
        );

        $statuses = array_merge( $statuses, $new_statuses );
        return $statuses;
}
add_filter( 'wc_memberships_user_membership_statuses', 'sv_wc_memberships_add_membership_statuses' );

wc_memberships_active_access_membership_statuses

@since

 

1.7.0

 

@param

 

array $statuses array of statuses valid for content access

Filters the user memberships status that will give the customer access to restricted content.

wc_memberships_valid_membership_statuses_for_cancel

@since

 

1.0.0

 

@param

 

array $statuses Array of statuses valid for cancellation

 

@return

 

array – updated array of statuses

Filters the user membership statuses that can be cancelled by the customer.

wc_memberships_valid_membership_statuses_for_renewal

@since

 

1.0.0

 

@param

 

array $statuses Array of statuses valid for renewal

 

@return

 

array – updated array of statuses

Filters the user membership statuses that can be renewed by the customer.

wc_memberships_bulk_edit_user_memberships_status_options

@since

 

1.0.0

 

@param

 

array $statuses Array of bulk-edit statuses available

 

@return

 

array – updated array of statuses

Filter the status options available in user memberships bulk edit box.

Filters: Settings

wc_memberships_general_settings

@since

 

1.0.0

 

@param

 

array $settings Array of the plugin settings

 

@return

 

array – updated settings array

Filters the Memberships > General Settings.

wc_memberships_products_settings

@since

 

1.0.0

 

@param

 

array $settings Array of the plugin settings

 

@return

 

array – updated settings array

Filters the Memberships > Products Settings.

Filters: Excluded from Restriction

wc_memberships_content_restriction_excluded_post_types

@since

 

1.0.0

 

@param

 

array $post_types List of post types to exclude

 

@return

 

array – the updated array of post types

Creates a blacklist to exclude post types from content restriction content type options. Helpful if CPTs are added from other plugins that shouldn’t be available in content restriction rules.

Example to remove Sensei Messages from posts that can be restricted:

<?php // only copy this line if needed
/**
 * Remove post types from the membership plan restriction options
 * Example: remove Sensei Messages from post types that can be restricted
 *
 * @param array $blacklist the array of post types to exclude from restriction options
 * @return array $blacklist the updated array of post types to exclude
 */
function sv_wc_memberships_add_post_type_to_blacklist( $blacklist ) {

        $blacklist[] = 'sensei_message';
        return $blacklist;
}
add_filter( 'wc_memberships_content_restriction_excluded_post_types', 'sv_wc_memberships_add_post_type_to_blacklist' );

wc_memberships_{$rule_type}_excluded_taxonomies

@since

 

1.0.0

 

@param

 

array $taxonomies List of taxonomies to exclude

 

@return

 

array – updated taxonomy list

Excludes taxonomies from restriction rules. Rule type can be content_restriction, product_restriction, or purchasing_discount.

Filters: Meta Boxes

wc_memberships_product_data_tabs

@since

 

1.0.0

 

@param

 

array $tabs Associative array of memberships data tabs

 

@return

 

array – updated tab array

Filters product memberships data tabs in the Membership meta box to add or remove tabs.

wc_membership_plan_data_tabs

@since

 

1.0.0

 

@param

 

array $tabs Associative array of membership plan tabs

 

@return

 

array – updated tab array

Filters membership plan data tabs on the edit membership plan pages.

Actions: General

wc_memberships_activated

Runs when Memberships is activated.

wc_memberships_deactivated

Runs when Memberships is deactivated.

wc_memberships_duplicate_membership_plan

@since

 

1.0.0

 

@param

 

int $new_id New plan ID

 

@param

 

WP_Post $post Original plan object

Fires after a membership plan has been duplicated.

Actions: Edit User Memberships

wc_memberships_before_user_membership_notes

@since

 

1.0.0

 

@param

 

WC_Memberships_User_Membership $user_membership The user membership

Fires at the beginning of the user membership notes meta box.

wc_memberships_after_user_membership_notes

@since

 

1.0.0

 

@param

 

WC_Memberships_User_Membership $user_membership The user membership

Fires at the end of the user membership notes meta box.

wc_memberships_before_user_membership_member_details

@since

 

1.0.0

 

@param

 

int $user_id The member (user) ID

 

@param

 

int $user_membership_id The post id of the user membership post

Fires at the beginning of the member details meta box.

wc_memberships_after_user_membership_member_details

@since

 

1.0.0

 

@param

 

int $user_id The member (user) ID

 

@param

 

int $user_membership_id The post id of the user membership post

Fires at the end of the member details meta box.

wc_memberships_before_user_membership_details

@since

 

1.0.0

 

@param

 

WC_Memberships_User_Membership $user_membership The user membership

Fires before the membership details in edit user membership screen.

wc_memberships_after_user_membership_details

@since

 

1.0.0

 

@param

 

WC_Memberships_User_Membership $user_membership The user membership

Fires after the membership details in edit user membership screen.

wc_memberships_before_user_membership_billing_details

@since

 

1.0.0

 

@param

 

WC_Memberships_User_Membership $user_membership The user membership

Fires before the billing details in edit user membership screen.

wc_memberships_after_user_membership_billing_details

@since

 

1.0.0

 

@param

 

WC_Memberships_User_Membership $user_membership The user membership

Fires after the billing details in edit user membership screen.

wc_memberships_user_membership_actions_start

@since

 

1.0.0

 

@param

 

int $post_id The post id of the wc_user_membership post

Fires at the start of the user membership actions meta box.

wc_memberships_user_membership_actions_end

@since

 

1.0.0

 

@param

 

int $post_id The post id of the wc_user_membership post

Fires at the end of the user membership actions meta box.

Actions: Restriction Meta Boxes

wc_memberships_data_product_write_panel_tabs

Fires after the product memberships data write panel tabs are displayed.

wc_memberships_data_options_restrict_product

Fires after the product memberships data product restriction panel is displayed.

wc_memberships_data_options_grant_access

Fires after the product memberships data grant access panel is displayed.

wc_memberships_data_options_purchasing_discounts

Fires after the membership plan purchasing discounts panel is displayed.

wc_memberships_data_product_panels

Fires after the product memberships data panels are displayed.

Actions: Edit Membership Plan

wc_membership_plan_write_panel_tabs

Fires after the membership plan write panel tabs are displayed.

wc_membership_plan_options_membership_plan_data_general

Fires after the membership plan general data panel is displayed.

wc_membership_plan_options_membership_plan_data_restrict_content

Fires after the membership plan content restriction panel is displayed.

wc_membership_plan_options_membership_plan_data_restrict_products

Fires after the membership plan product restriction panel is displayed.

wc_membership_plan_options_membership_plan_data_purchasing_discounts

Fires after the membership plan purchasing discounts panel is displayed.

wc_membership_plan_options_membership_plan_members_area

Fires after the membership plan members area panel is displayed.

wc_membership_plan_data_panels

Fires after the membership plan data panels are displayed.

Actions: Membership Lifecycle

wc_memberships_grant_membership_access_from_purchase

@since

 

1.0.0

 

@param

 

WC_Memberships_Membership_Plan $membership_plan The plan that user was granted access to

 

@param

 

array $args {

 

• • @type int|string $user_id user ID for order
  • @type int|string $product_id product ID that grants access
  • @type int|string $order_id order ID
  • @type int|string $user_membership_id post ID for the new user membership

}

Fires after a user has been granted membership access from a purchase.

wc_memberships_user_membership_saved

@since

 

1.3.8

 

@param

 

/WC_Memberships_Membership_Plan $membership_plan The plan that user was granted access to

 

@param

 

array $args {

 

• • @type int|string $user_id user ID for the membership
  • @type int|string $user_membership_id post ID for the new user membership
  • @type bool $is_update true if the membership is being updated, false if new

}

Fires after a user has been granted membership access, either from purchase, from programmatically creating memberships, or from admin action.

wc_memberships_user_membership_created

@since

 

1.3.8

 

@param

 

/WC_Memberships_Membership_Plan $membership_plan The plan that user was granted access to

 

@param

 

array $args {

 

• • @type int|string $user_id user ID for the membership
  • @type int|string $user_membership_id post ID for the new user membership
  • @type bool $is_update true if the membership is being updated, false if new

}

Fires after a user has been granted membership access. This action hook is similar to wc_memberships_user_membership_saved, but won’t fire when memberships are manually created from admin.

wc_memberships_cancelled_user_membership

@since

 

1.0.0

 

@param

 

int $user_membership_id

Fires right after a user membership has been cancelled by the customer.

wc_memberships_user_membership_status_changed

@since

 

1.0.0

 

@param

 

WC_Memberships_User_Membership $user_membership

 

@param

 

string $old_status Old status, without the wcm- prefix

 

@param

 

string $new_status New status, without the wcm- prefix

Fires when user membership status is updated.

Here’s an example of a basic handler to change user roles based on active / inactive membership status.

wc_memberships_new_user_membership_note

@since

 

1.0.0

 

@param

 

array $data {

 

• • @type int|string $user_membership_id post ID for the new user membership
  • @type object $note the user membership note (comment object) added
  • @type bool $notify true if the member will be notified

}

Fires after a new membership note is added.

User Documentation

All done here? Return to documentation overview →

The post WooCommerce Memberships Admin Hook Reference first appeared on CODIBU.

If you’re looking for more details on modifying Memberships or “For Developers” samples, please view our developer documentation.

Member Area

Remove Cancel action from My Memberships table

The actions in the “My Memberships” table can be removed if you don’t want to allow your members to manage their own memberships. This snippet removes the “Cancel” action from the “My Memberships” table in the account area.

Note: Memberships automatically does this for you if a membership is tied to a subscription, forcing cancellation via the billing instead.

Remove End Date Column from My Memberships

Removes the “End Date” column from being displayed for all user memberships.

Remove Type Column from My Content Area

The “My Content” section of the Member Area will show the content type (Post, Page, Project, Forum, etc) as this paginated section shows all accessible content (posts, pages, custom post types) on the site. This snippet removes the “Type” column if its display isn’t needed.

Remove Description Column from My Products Area

The paginated “My Products” section of the Member Area will show all accessible products for the member (those the plan grants viewing / purchasing for). This snippet removes the “Description” / Excerpt column if its display isn’t needed.

Blog & Posts

Show Lock Icon on Restricted Posts

This snippet requires your site to have loaded FontAwesome already, as it uses the FontAwesome lock icon. It will show a lock next to the title of any post the member does not have access to yet, or any restricted posts for non-members.

<?php // only copy if needed
/**
 * Display a FontAwesome lock icon next to the post title if a member does not have access
 *  with WooCommerce Memberships.
 *
 * REQUIRES FontAwesome to be loaded already
 *
 * @param string $post_title the post title
 * @param int $post_id the WordPress post ID
 * @return string the updated title
 */
function sv_wc_memberships_add_post_lock_icon( $title, $post_id ) {

        if ( is_admin() ) {
                return $title;
        }

        // show the lock icon if the post is restricted, or access is delayed
        if (   ! current_user_can( 'wc_memberships_view_delayed_post_content',    $post_id )
            || ! current_user_can( 'wc_memberships_view_restricted_post_content', $post_id ) ) {

                $title = "<i class='fa fa-lock' aria-hidden='true'></i> {$title}";
        }

        return $title;
}
add_filter( 'the_title', 'sv_wc_memberships_add_post_lock_icon', 10, 2 );

Shop Pages

Remove Member Discount Badges

The member discount badge’s HTML is filterable, and therefore it can be removed completely using this snippet:

add_filter( 'wc_memberships_member_discount_badge', '__return_empty_string' );

Disable Discount Stacking

By default, Memberships will assume that members should always have all benefits of a membership plan. However, this could potentially result in a member receiving 2 discounts or more on a product if the member has multiple plans with discounts.

If you want to disable this behavior, Memberships can instead choose the best discount only instead of stacking discounts — add this snippet to do so:

add_filter( 'wc_memberships_allow_cumulative_member_discounts', '__return_false' );

Integrations

Add Social Login Buttons to Restriction Messages

You can add WooCommerce Social Login buttons into the “content restricted” notices to make it easier for members with a linked account to log in.

We do have this on our Memberships / Social Login roadmaps to add support for. Until this happens within the plugins themselves, you could add this code snippet to show login buttons in content restriction notices.

Other Snippets

Grant Access only from Completed Orders

By default, Memberships grants access to customers for any processing or completed order on your site since these represent paid orders. If you’d like access to only be granted when an order is ‘completed’, but not while it’s ‘processing’, you can use this snippet:

<?php // only copy this line if needed
/**
 * Removes membership access for processing orders
 * so access is only granted at when orders are complete
 */
function sv_wc_memberships_remove_processing_access() {

        // make sure Memberships is active first
        if ( function_exists( 'wc_memberships' ) ) {

                remove_action( 'woocommerce_order_status_processing', array( wc_memberships()->get_plans_instance(), 'grant_access_to_membership_from_order' ), 9 );
        }

        // Add support for Teams for Memberships but make sure it is active first
        if ( function_exists( 'wc_memberships_for_teams' ) ) {

                remove_action( 'woocommerce_order_status_processing', array( wc_memberships_for_teams()->get_orders_instance(), 'process_team_actions_for_order' ), 10 );
        }
}
add_action( 'init', 'sv_wc_memberships_remove_processing_access' );

If you want to add statuses (such as custom statuses) that grant access, our developer documentation can help.

Create My Memberships Shortcode

If you want to output the “My Memberships” table outside of the “My Account” area, you can create a shortcode to do so. Please have a look at this snippet.

More Snippets

We keep a collection of team snippets for our plugins in this repository. However, the same policy applies — we cannot support these snippets, assist with implementation, or assist with further customizations.

Table of Contents

All done here? Return to documentation overview →

The post WooCommerce Memberships Snippet Samples first appeared on CODIBU.

Overview

WooCommerce Memberships is a large and complex plugin, but we’ve built it with the aim of being extensible and developer-friendly. This is an overview of how data is stored in the Memberships plugin, which can be accessed via WordPress core methods, WooCommerce methods, or via methods within the plugin.

Our frontend hook reference, admin hook reference, and function / conditional check reference are useful for specific filters, actions, checks, or global functions that will help you while extending Memberships, while this guide provides basic insight into how data is stored.

Membership plans

Membership plans are stored as a custom post type: wc_membership_plan

Each plan is a post within this post type, so you can easily query all available plans using WordPress core functions, such as get_posts().

Some pieces of plan data are stored as post meta for the plan’s post, and you can also easily add your own meta for customizations with WP functions. Here are a few meta key / values of interest:

Even though plans each contain restriction rules, these rules are not stored as part of the plan’s post meta, and are stored together as an option.

Restriction rules

Restriction and discount rules are stored as options for performance reasons. Mosts hosts cache options, they’re persistent on each page load, and they can be accessed easily.

Searching for option names that contain wc_memberships in your database will yield all options for both Memberships settings and restriction rules.

User memberships

User memberships are each posts in the custom post type: wc_user_membership

This is done to prevent dumping all plan details into user meta (which helps to avoid using serialized data, as it’s not easily query-able) and to improve flexibility.

As memberships are posts, you can easily query membership with get_posts(), and can leverage postmeta for custom data.

Each user membership post is a child post of the associated membership plan. For example, User 1’s Silver Membership is a child post of the Silver Membership plan.

The member is assigned as the author of the user membership post, and members can be the author of more than one post (which means they can have access to more than one plan). Checking the author of a user membership post will give you the member’s user ID.

The post object contains some membership data, such as the membership status, which is the post status. However, rather than using WP method to get this data, a better approach would be to use the user membership data accessors as outlined in our function / conditional check reference.

A quick example: in the case of the membership status, this will return the status name rather than the post status, which includes the wcm- prefix in the slug.

The rest of the plan data is stored as post meta for the user membership post, as post meta and can be accessed, changed, and added easily via WordPress core methods.

Membership notes

Membership notes are stored as WordPress comments for the user membership post. Their functionality is very similar to WooCommerce order notes. If a comment was sent to the member, then the commentmeta for that comment will have notified set to: 1

Table of Contents

All done here? Return to documentation overview →

The post WooCommerce Memberships Data Structure first appeared on CODIBU.

For Developers: Checks & Functions

WooCommerce Memberships provides several methods for checking data on content restriction and user memberships.

This reference includes helpful conditional checks and global functions for Memberships. Conditional checks return bool true or false. For example:

if ( wc_memberships_is_product_viewing_restricted() ) {
    echo 'MARCO!';
} else {
    echo 'POLO!';
}

This would check if viewing the current product is restricted to members or not so we can print a different message on the product page. We can also pass in a product id instead to check for a particular product.

Conditional Checks: Products

wc_memberships_is_product_viewing_restricted()

@since

 

1.0.0

 

@param

 

int|null $post_id Optional, defaults to current post

 

@return

 

bool true if viewing is restricted

Checks if product viewing is restricted.

wc_memberships_is_product_purchasing_restricted()

@since

 

1.0.0

 

@param

 

int|null $post_id Optional, defaults to current post

 

@return

 

bool true if purchasing is restricted

Checks if product purchasing is restricted.

Example:

<?php // only copy this line if needed
/**
 * Check if product purchasing is retricted
 * Example: Add a restricted product notice
 * Display a top notice to non-members for members-only products
 */
function sv_wc_memberships_members_only_product_notice() {

        // bail if Memberships isn't active
        if ( ! function_exists( 'wc_memberships' ) ) {
                return;
        }

        $user_id = get_current_user_id();

        // Bail if the user is already a silver or gold member
        if ( wc_memberships_is_user_active_member( $user_id, 'silver' ) || wc_memberships_is_user_active_member( $user_id, 'gold' ) ) {
                return;
        }

        // Add our top notice if purchasing is restricted
        if ( wc_memberships_is_product_purchasing_restricted() ) {
                wc_print_notice( 'This is a preview! Only silver or gold members can purchase this product.', 'notice' );
        }
}
add_action( 'woocommerce_before_single_product', 'sv_wc_memberships_members_only_product_notice' );

wc_memberships_product_has_member_discount()

@since

 

1.0.0

 

@param

 

int|null $product_id Product ID: optional, defaults to current product

 

@return

 

bool true if product has discount

Checks if a member discount is present for the product.

wc_memberships_user_has_member_discount()

@since

 

1.0.0

 

@param

 

int|null $product_id Product ID: optional, defaults to current product

 

@return

 

bool true if current user has discount

Checks if the current user has a member discount on the product.

Example:

<?php // only copy this line if needed
/**
 * Check if a product has a member discount
 * Example: Display a member discount notice
 */
function sv_wc_memberships_member_discount_product_notice() {

        // bail if Memberships isn't active
        if ( ! function_exists( 'wc_memberships' ) ) {
                return;
        }

        // Set a discount end date
        $discount_ends = date_i18n( wc_date_format(), strtotime( '2015-12-31' ) );

        // Add our top notice if the member has a discount
        if ( wc_memberships_user_has_member_discount() ) {
                wc_print_notice( sprintf( 'Act fast! Your member discount ends on %s.', $discount_ends ), 'notice' );
        }
}
add_action( 'woocommerce_before_single_product', 'sv_wc_memberships_member_discount_product_notice' );

Conditional Checks: Content

wc_memberships_is_post_content_restricted()

@since

 

1.0.0

 

@param

 

int|null $post_id Optional, defaults to current post

 

@return

 

bool true if content is restricted

Checks if a post or page is restricted.

Conditional Checks: Members

wc_memberships_is_user_member()

@since

 

1.0.0

 

@param

 

int $user_id Optional, defaults to current user

 

@param

 

int|string $membership_plan Membership Plan slug, post object or related post ID

 

@return

 

bool true if user is a member of the plan

Checks if a user is a member for a particular plan.

wc_memberships_is_user_active_member()

@since

 

1.0.0

 

@param

 

int $user_id Optional, defaults to current user

 

@param

 

int|string $membership_plan Membership Plan slug, post object or related post ID

 

@return

 

bool true if user is an active member of the plan

Checks if a user is an active member for a particular plan.

Example: display a notice to non-members / inactive members

Functions: Restricted Content

wc_memberships_restrict()

@since

 

1.0.0

 

@param

 

string $content

 

@param

 

string|int|array $membership_plans Optional: the membership plan or plans to check against; Accepts a plan slug, id, or an array of slugs or IDs. Default: all plans

 

@param

 

string $delay

 

@param

 

bool $exclude_trial

Restrict content to specific membership plans.See the [wcm_restrict] shortcode for an example.

wc_memberships_get_user_access_time

@since

 

1.4.0

 

@param

 

int $user_id User to get access time for

 

@param

 

array $target Associative array of content type and content id to access to

 

@param

 

string $action Type of access, ‘view’ or ‘purchase’ (products only)

 

@param

 

bool $gmt Whether to return a UTC timestamp (default false, uses site timezone)

 

@return

 

int|null Timestamp of start access time

Returns user access start timestamp (in site timezone) for content or a product. Note: for now $target only supports 'post' => id or 'product' => id

Functions: Membership Plans

wc_memberships_get_membership_plan()

@since

 

1.0.0

 

@param

 

int|string|WC_Memberships_Membership_Plan $membership_plan Post object, ID or slug of the membership plan

 

@return

 

WC_Memberships_Membership_Plan|false Returns the plan object or false on failure

Main function for returning a membership plan.

wc_memberships_get_membership_plans()

@since

 

1.0.0

 

@param

 

array $args Optional array of arguments, same as for get_posts()

 

@return

 

WC_Memberships_Membership_Plan[]

Main function for returning all available membership plans.

Functions: User Memberships

wc_memberships_get_user_active_memberships()

@since

 

1.7.0

 

@param

 

int $user_id WP user ID, defaults to current user

Returns an array of active memberships plan objects; empty if the user is not an active member. Supports statuses added for WooCommerce Subscriptions as well.

$memberships = wc_memberships_get_user_active_memberships( $user_id );

if ( ! empty( $memberships ) ) {
    // do something for this active member
}

wc_memberships_get_user_membership()

@since

 

1.0.0

 

@param

 

mixed $id Optional. Post object or post ID of the user membership, or user ID

 

@param

 

mixed $plan Optional. Membership Plan slug, post object or related post ID

 

@return

 

WC_Memberships_User_Membership|false The User Membership or false if not found

Main function for returning a user membership; supports getting user membership by membership ID, Post object, or a combination of the user ID and membership plan id/slug/Post object.

If no $id is provided, defaults to getting the membership for the current user.

Example of getting a new, automatically created membership to then set a membership note:

<?php // only copy if needed
/**
 * IF USING MEMBERSHIPS 1.7+
 * This snippet is likely not needed, you can set up a plan to grant access at registration
 *
 * However, this shows usage of programmatic membership creation for developers.
 */
/**
 * Programmatically create a user membership
 * Example: automatically grant membership access to a plan at WP user registration
 * Requires Memberships 1.3+
 *
 * @param int $user_id the ID of the newly created user
 */
function sv_wc_memberships_user_membership_at_registration( $user_id ) {

        // bail if Memberships isn't active
        if ( ! function_exists( 'wc_memberships' ) ) {
                return;
        }

        $args = array(
                // Enter the ID (post ID) of the plan to grant at registration
                'plan_id' => 253,
                'user_id' => $user_id,
        );

        // magic!
        wc_memberships_create_user_membership( $args );

        // Optional: get the new membership and add a note so we know how this was registered.
        $user_membership = wc_memberships_get_user_membership( $user_id, $args['plan_id'] );
        $user_membership->add_note( 'Membership access granted automatically from registration.' );
}
add_action( 'user_register', 'sv_wc_memberships_user_membership_at_registration', 15 );

wc_memberships_get_user_memberships()

@since

 

1.0.0

 

@param

 

int $user_id Optional, defaults to current user

 

@param

 

array $args Optional arguments

 

@return

 

WC_Memberships_User_Membership[]|null array of user memberships

With version 1.4+, can also pass $args as a second parameter; currently accepts “status” and defaults to “any” status. However, this could be used to query all active memberships:

// get all active memberships for a user; 
// returns an array of active user membership objects
// or null if no memberships are found
$user_id = get_current_user_id();
$args = array( 
    'status' => array( 'active', 'complimentary', 'pending' ),
);  
$active_memberships = wc_memberships_get_user_memberships( $user_id, $args );

wc_memberships_create_user_membership()

@since

 

1.3.0

 

@param

 

array $args Array of arguments {

 

• • @type int|string $user_membership_id membership / post ID for the membership (used when renewing)
  • @type int|string $plan_id membership plan / post object ID
  • @type int|string $user_id user ID for the membership
  • @type int|string $product_id the ID for the access-granting product
  • @type int|string $order_id the order in which access is granted

}

 

@param

 

string $action Action – either ‘create’ or ‘renew’ — when in doubt, use ‘create’

 

@return

 

WC_Memberships_User_Membership|WP_Error

Example:

Functions: Other Functions

wc_memberships_get_memberships_from_subscription()

@since

 

1.6.0

 

@param

 

string|int|WC_Subscription $subscription A Subscription id, object (or key for Subscriptions < 2.0.0)

 

@return

 

WC_Memberships_User_Membership[] An array of User Membership objects or empty array if none found

wc_memberships_get_member_product_discount()

@since

 

1.4.0

 

@param

 

WC_Memberships_User_Membership $user_membership The user membership object

 

@param

 

int|WC_Product $product The product object or id to get discount for

 

@return

 

string discount value

Returns member discount (string) for a product.

wc_memberships_get_members_area_url()

@since

 

1.4.0

 

@param

 

int|WC_Memberships_Membership_Plan $membership_plan Object or id

 

@param

 

string $member_area_section Optional, which section of the member area to point to

 

@param

 

int|string $paged Optional, for paged sections

 

@return

 

string Unescaped URL

Gets the member area URL for a particular membership plan.

wc_memberships_get_members_area_sections()

@since

 

1.4.0

 

@param

 

int|string $membership_plan Optional: membership plan id for filtering purposes

 

@return

 

array of sections

Gets the sections for the member area.

Table of Contents

All done here? Return to documentation overview →

The post WooCommerce Memberships Function Reference first appeared on CODIBU.

For Developers: Frontend Hook Reference

WooCommerce Memberships is extremely extensible and offers ample actions and filters for developers to customize it as needed. If a hook doesn’t exist where you think it should, please submit a ticket so we can consider its addition.

This hook reference includes some of the actions and filters developers may find useful while customizing the plugin, but is not an exhaustive reference of all plugin hooks. Inline docs include parameters and returned values for more detail — the appropriate file for each hook is listed so you can refer to it.

Filters: Member Messages

wc_memberships_user_membership_cancelled_notice

@since

 

1.0.0

 

@param

 

string $notice

 

@return

 

string – updated notice

Filter the user cancelled membership message on frontend — defaults to, “Your membership was cancelled.”

wc_memberships_member_login_message

@since

 

1.3.8

 

@param

 

string $message The message text

 

@return

 

string – the updated message

Filter the member login notice message. This can be configured under settings as well, but we recommend using the default message and filtering as needed, as by default this message responds to the number of discounted items in the cart.

Filters: Restriction Messages

wc_memberships_the_restricted_content

@since

 

1.6.0

 

@param

 

string $content HTML content displayed for the post

 

@param

 

bool $restricted Whether the content is restricted

 

@param

 

string $message The restriction message applied, could be empty string

 

@param

 

WP_Post $post The post being restricted

 

@return

 

string – the updated restricted content HTML

If you wanted to remove a restriction notice completely, you could use this filter to modify the message HTML or delete it. This example snippet shows its use for modifying the restricted content, so you could return the content without the restriction message, or modify the message and return the content as desired.

wc_memberships_product_viewing_restricted_message

@since

 

1.0.0

 

@param

 

string $message The restriction message

 

@param

 

int $product_id ID of the product being restricted

 

@param

 

array $products Array of product IDs that grant access to this product

 

@return

 

string – the updated restriction message

Filters the product viewing restricted message.

wc_memberships_product_purchasing_restricted_message

@since

 

1.0.0

 

@param

 

string $message The restriction message

 

@param

 

int $product_id ID of the product being restricted

 

@param

 

array $products Array of product IDs that grant access to this product

 

@return

 

string – the updated restriction message

Filters the product purchasing restricted message.

wc_memberships_content_restricted_message

@since

 

1.0.0

 

@param

 

string $message The restriction message

 

@param

 

int $post_id ID of the product being restricted

 

@param

 

array $products Array of product IDs that grant access to this product

 

@return

 

string – the updated restriction message

Filters the content restricted message.

wc_memberships_get_content_delayed_message

@since

 

1.3.1

 

@param

 

string $message Delayed content message

 

@param

 

int $post_id Post ID that the message applies to

 

@param

 

string $access_time Access time timestamp

 

@return

 

string – the updated restriction message

Filters the content delayed message.

Example to show a custom delayed message for the “project” post type:

<?php // only copy this line if needed
/**
 * Change the "content delayed" message displayed to members who will have access, but not yet
 * Example: change the delayed content message for the "Projects" post type
 *
 * @param string $message the message html
 * @param string[] $args {
 *      @type string $context whether the message appears in the context of a notice or elsewhere
 *      @type WP_Post $post the post object
 *      @type int $post_id the ID of the restricted post
 *      @type int $access_time the user access timestamp
 *      @type int[] $products the product IDs that grant access
 *      @type string $rule_type the related rule type
 *      @type string|string[] $classes optional message CSS classes
 * }
 * @return string $message the updated message text
 */
function sv_wc_memberships_change_content_delayed_message( $message, $args ) {

        // only change the delayed message if a project is being viewed
        // {date} will be replaced automatically after this filter with access date
        if ( 'project' === get_post_type( $args['post_id'] ) ) {
                $message = 'This project is part of your membership, but not yet! You will gain access on {date}';
        }

        return $message;
}
add_filter( 'wc_memberships_content_delayed_message', 'sv_wc_memberships_change_content_delayed_message', 10, 2 );

wc_memberships_product_taxonomy_viewing_restricted_message

@since

 

1.4.0

 

@param

 

string $message The restriction message

 

@param

 

string $taxonomy Product taxonomy

 

@param

 

int $term_id Product taxonomy term id

 

@param

 

array $products Array of product IDs that grant access to products taxonomy

 

@return

 

string – the updated restriction message

Filters the product category viewing restricted message. Defaults to, “This product category can only be viewed by members. To view this category, sign up by purchasing {products}, or log in if you are a member.” If no product purchases can grant access to the category, defaults to, “This product category can only be viewed by members.”

wc_memberships_product_term_viewing_delayed_message

@since

 

1.4.0

 

@param

 

string $message The delayed access message

 

@param

 

string $taxonomy Product taxonomy

 

@param

 

int $term_id Product taxonomy term id

 

@return

 

string – the updated restriction message

Filter the product term viewing delayed access message. Defaults to, “This product category is part of your membership, but not yet! You will gain access on {date}.”

wc_memberships_member_discount_message

@since

 

1.0.0

 

@param

 

string $message The discount message

 

@param

 

int $product_id ID of the product that has member discounts

 

@param

 

array $products Array of product IDs that grant access to this product

 

@return

 

string – the updated discount message

Filters the member discount message shown to non-members or non-logged in users.

Filters: Member Discounts

wc_memberships_member_prices_use_discount_format

@since

 

1.3.0

 

@param

 

bool $use_discount_format Defaults to true

located in: /includes/class-wc-memberships-member-discounts.php

Controls whether or not member prices should use discount format when displayed. If returned false, discounted prices will be shown without the original price. Defaults to true.

wc_memberships_member_prices_display_sale_price

@since

 

1.3.0

 

@param

 

bool $display_sale_price Defaults to false

located in: /includes/class-wc-memberships-member-discounts.php

Controls whether or not member prices should display sale prices as well. If returned true, the original price, sale price, and member price will be shown.

Default: $nonmember price $member price
Returned True: $original price $sale price $member price

Defaults to false — only shows sale price [if set] and member price, or original price and member price.

wc_memberships_member_discount_badge

@since

 

1.0.0

 

@param

 

string $badge_html the member discount badge HTML

 

@param

 

WP_Post $post Post object

 

@param

 

WC_Product $product Product object

 

@return

 

string – updated badge HTML

located in: /templates/loop/member-discount-badge.php

Filters the Member Discount badge HTML.

Filters: My Memberships

wc_memberships_my_memberships_title

@since

 

1.5.0

 

@param

 

string $title My Memberships table title

 

@return

 

string – updated title

located in: /templates/myaccount/my-memberships.php

Filters the title of the My Memberships table. Defaults to “My Memberships”.

wc_memberships_my_memberships_column_names

@since

 

1.4.0

 

@param

 

array $my_memberships_columns Associative array of column ids and names

 

@param

 

int $user_id ID of logged in user

 

@return

 

array – updated array of columns

located in: /templates/myaccount/my-memberships.php

Filters the My Memberships table columns in My Account page. Example: remove “end date” column:

<?php // only copy this line if needed
/**
 * Remove the "End Date" column from the My Memberships table
 *
 * @param array $columns the columns in the "My Memberships" table
 * @return array $columns the updated array of columns
 */
function sv_wc_memberships_remove_end_date_column( $columns ) {

        unset( $columns['membership-end-date'] );
        return $columns;
}
add_filter( 'wc_memberships_my_memberships_column_names', 'sv_wc_memberships_remove_end_date_column' );

wc_memberships_get_renew_membership_url

@since

 

1.0.0

 

@param

 

string $url renewal URL

 

@param

 

WC_Memberships_User_Membership $user_membership

 

@return

 

string – updated URL

located in: /includes/class-wc-memberships-user-membership.php

Filters the renewal URL for a membership. Helpful if you want to change the renewal URL / button to “upgrade” a membership.

Example: Renew trial plan by purchasing an upgrade.

wc_memberships_get_cancel_membership_url

@since

 

1.0.0

 

@param

 

string $url cancellation URL

 

@param

 

WC_Memberships_User_Membership $user_membership

 

@return

 

string – updated URL

located in: /includes/class-wc-memberships-user-membership.php

Filters the cancel URL for a membership. Not needed for memberships purchased via subscription, as the button is hidden.

Filters: Member Area

wc_membership_plan_members_area_sections

@since

 

1.4.0

 

@param

 

array $member_area_sections Associative array with member area id and label of each section

 

@param

 

int|string $membership_plan Optional, the current membership plan, might be empty

 

@return

 

array – updated array of sections

located in: /includes/wc-memberships-membership-plan-functions.php

Filters the available choices for the members area sections of a membership plan.

Example: Rename the section links:

<?php // only copy this line if needed
/**
 * Rename the section links for the "Member Area"
 * Can rename any section links using the section ID
 *
 * @param array $sections the array of section link IDs and text
 * @return array $sections the updated array of section links
 */
function sv_wc_memberships_rename_member_area_sections( $sections ) {

        $sections['my-membership-content']   = __( 'Club Articles', 'my-text-domain' );
        $sections['my-membership-products']  = __( 'Club Products', 'my-text-domain' );
        $sections['my-membership-discounts'] = __( 'Exclusive Discounts', 'my-text-domain' );
        $sections['my-membership-notes']     = __( 'Notes from MySite', 'my-text-domain' );

        return $sections;
}
add_filter( 'wc_membership_plan_members_area_sections', 'sv_wc_memberships_rename_member_area_sections' );

wc_memberships_members_area_{$section}_actions

@since

 

1.4.0

 

@param

 

array $default_actions Associative array of actions

 

@param

 

WC_Memberships_User_Membership $user_membership User Membership object

 

@param

 

WC_Product|WP_Post|object $object Current object where the action is run (optional)

 

@return

 

array – updated array of actions

located in: /includes/wc-memberships-template-functions.php

Filter membership actions on My Account and Members Area pages. The $section is the member area section, e.g., ‘my-membership’, ‘my-membership-content’, etc.

Example: Remove “Cancel” button.

My Membership Content

wc_memberships_members_area_my_membership_content_title

@since

 

1.4.0

 

@param

 

string $title the section title

 

@return

 

string – the updated title

Filters the heading for the “My Content” section.

wc_memberships_members_area_my_membership_content_column_names

@since

 

1.4.0

 

@param

 

array $columns Associative array of column ids and names

 

@param

 

int $user_id ID of logged in user

 

@return

 

array – updated array of columns

Filters the columns in the “My Content” section. If adding a column, be sure to also fill that column with content using the

wc_memberships_members_area_my_membership_content_column_{$column_id}

action. Example to add an “Author” column:

<?php // only copy this line if needed
/**
 * Add an "Author" column to the "My Content" table in the members area
 *
 * @param array $columns the columsn in the "My Content" table
 * @return array $columns the updated array of columns
 */
function sv_wc_memberships_my_content_table_add_column( $columns ) {

        $new_columns = array();

        foreach ( $columns as $column_id => $column_name ) {

                $new_columns[ $column_id ] = $column_name;

                // insert our new "Author" column after the "Title" column
                if ( 'membership-content-title' === $column_id ) {
                        $new_columns['membership-content-author'] = __( 'Author', 'your-textdomain' );
                }
        }

        return $new_columns;
}
add_filter( 'wc_memberships_members_area_my_membership_content_column_names', 'sv_wc_memberships_my_content_table_add_column', 11 );
/**
 * Fills the "Author" column with the post author
 *
 * @param WP_Post $post the post object used for the row's display
 */
function sv_wc_memberships_my_content_table_add_column_content( $post ) {

        $author = get_user_by( 'ID', $post->post_author );
        echo $author->display_name;
}
add_action( 'wc_memberships_members_area_my_membership_content_column_membership-content-author', 'sv_wc_memberships_my_content_table_add_column_content' );

You could also remove columns: example to remove “Type” column

My Membership Products

wc_memberships_members_area_my_membership_products_title

@since

 

1.4.0

 

@param

 

string $title the section title

 

@return

 

string – the updated title

Filters the heading for the “My Products” section.

wc_memberships_members_area_my_membership_products_column_names

@since

 

1.4.0

 

@param

 

array $columns Associative array of column ids and names

 

@param

 

int $user_id ID of logged in user

 

@return

 

array – updated array of columns

Filters the columns in the “My Products” section. If adding a column, be sure to also fill that column with content using the

wc_memberships_members_area_my_membership_products_column_{$column_id}

action.

My Membership Discounts

wc_memberships_members_area_my_membership_discounts_title

@since

 

1.4.0

 

@param

 

string $title the section title

 

@return

 

string – the updated title

Filters the heading for the “My Discounts” section. Example to change the heading to “Exclusive Discounts”.

wc_memberships_members_area_my_membership_discounts_column_names

@since

 

1.4.0

 

@param

 

array $columns Associative array of column ids and names

 

@param

 

int $user_id ID of logged in user

 

@return

 

array – updated array of columns

Filters the columns in the “My Discounts” section. If adding a column, be sure to also fill that column with content using the

wc_memberships_members_area_my_membership_discounts_column_{$column_id}

action.

wc_memberships_members_area_show_only_active_discounts

@since

 

1.4.0

 

@param

 

bool $show_only_active_discounts Default true

 

@param

 

int $user_id ID of logged in user

 

@param

 

int $product_id ID of discounted product

Filters whether the “My Discounts” area should list all discounts for the membership or only active discounts for the membership. Return false to show all discounts (including inactive discounts).

Membership Notes

wc_memberships_members_area_my_membership_notes_title

@since

 

1.4.0

 

@param

 

string $title the section title

 

@return

 

string – the updated title

Filters the heading for the “Membership Notes” section.

wc_memberships_members_area_my_membership_notes_column_names

@since

 

1.4.0

 

@param

 

array $columns Associative array of column ids and names

 

@param

 

int $user_id ID of logged in user

 

@return

 

array – updated array of columns

Filters the columns in the “My Membership Notes” section. If adding a column, be sure to also fill that column with content using the

wc_memberships_members_area_my_membership_notes_column_{$column_id}

action.

Actions: My Memberships

wc_memberships_before_my_memberships

Fired before My Memberships table in My Account page.

wc_memberships_my_memberships_column_{$column_id}

@since

 

1.4.3

 

@param

 

WC_Memberships_User_Membership $user_membership

Fires when the column with $column_id is displayed in the My Memberships table. Used to fill a custom column with content.

wc_memberships_after_my_memberships

Fired after My Memberships table in My Account page.

Actions: Member Area

wc_memberships_before_members_area

@since

 

1.4.0

 

@param

 

string $section the section ID

Fires before each section of the member area.

wc_memberships_after_members_area

@since

 

1.4.0

 

@param

 

string $section the section ID

Fires after each section of the member area.

wc_memberships_members_area_my_membership_content_column_{$column_id}

@since

 

1.4.0

 

@param

 

WP_Post $post the post object for which the row’s data is shown

located in: /templates/myaccount/my-membership-content.php

Fired for any “My Content” column added with a custom ID. Fills the table cell with content for this column. See this example.

wc_memberships_members_area_my_membership_products_column_{$column_id}

@since

 

1.4.0

 

@param

 

WC_Product $product the product object for which the row’s data is shown

located in: /templates/myaccount/my-membership-products.php

Fired for any “My Products” column added with a custom ID. Fills the table cell with content for this column.

wc_memberships_members_area_my_membership_discounts_column_{$column_id}

@since

 

1.4.0

 

@param

 

WC_Product $product the product object for which the row’s data is shown

located in: /templates/myaccount/my-membership-discounts.php

Fired for any “My Discounts” column added with a custom ID. Fills the table cell with content for this column.

wc_memberships_members_area_my_membership_notes_column_{$column_id}

@since

 

1.4.0

 

@param

 

object $note the membership note comment object for the row

located in: /templates/myaccount/my-membership-notes.php

Fired for any “My Membership Notes” column added with a custom ID. Fills the table cell with content for this column.

Actions: General

wc_memberships_activated

Runs when Memberships is activated.

wc_memberships_deactivated

Runs when Memberships is deactivated.

wc_memberships_duplicate_membership_plan

@since

 

1.0.0

 

@param

 

int $new_id New plan ID

 

@param

 

WP_Post $post Original plan object

located in: /includes/admin/class-wc-memberships-admin-membership-plans.php

Fires after a membership plan has been duplicated.

Table of Contents

All done here? Return to documentation overview →

The post WooCommerce Memberships Frontend Hook Reference first appeared on CODIBU.