Useful Functions

This is a non-comprehensive list of functions from the plugin that might be useful.

Content Restriction

Check if user is member

These functions can be useful if you want to add restricted content directly in your PHP templates. It lets you check if a user is subscribed to one or more subscription plans.

pms_is_member( $user_id = '', $subscription_plans = array() );

$user_id -> the user ID we want to check, defaults to currently logged in user if empty
$subscription_plans -> array of subscription plan ids the user should be subscribed to

pms_is_member_of_plan( $subscription_plans, $user_id = '' );

This is similar to the function above, it just has the parameter in the reverse order.

Both functions will return true or false.

Example:

if( pms_is_member_of_plan( array( 123 ) ) ) {
    echo 'Content for plan 123';
}

Check if post is restricted for current user

pms_is_post_restricted( $post_id );

This function lets you check if a particular post is restricted for the current user or not. It will return true or false.

As an example, this function could be useful on an archive page if you want to display a custom icon for posts that the current user can’t access.

Member information

Retrieve information about a member

$member = pms_get_member( $user_id );

This function will return a PMS_Member object which contains information about the given user. The object has the following keys:

user_id
username
email
subscriptions – this key contains an array of subscriptions; each subscription is an array with the following keys
- id – id of the membership
- subscription_plan_id
- start_date
- expiration_date
- status
- payment_profile_id

Get a list of members

$args = array(
    'order'                      => 'DESC',
    'orderby'                    => 'ID',
    'number'                     => 10,
    'offset'                     => '',
    'subscription_plan_id'       => '',
    'member_subscription_status' => '',
    'search'                     => '',
    'group_owner'                => '',
    'payment_gateway'            => '',
    'start_date_beginning'       => '',
    'start_date_end'             => '',
    'expiration_date_beginning'  => '',
    'expiration_date_end'        => '',
);

// array with member objects based on arguments
$members = pms_get_members( $args );

Using this function you can grab a list of member objects based on certain arguments.

The function also takes a second parameter $count that can be set to `true` to make the function return the number of users instead of the member objects:

$members = pms_get_members( $args, true );

Payments

Retrieve information about a payment

$payment = pms_get_payment( $payment_id );

This function will return a PMS_Payment object which contains information about a certain payment. The object has the following keys:

id
user_id
subscription_id – this is the Subscription Plan ID, not the ID of the Membership
status
date
amount
currency
type
payment_gateway
transaction_id
profile_id
ip_address
discount_code

Get a list of payments

$args = array(
    'order'                => 'DESC',
    'orderby'              => 'id',
    'number'               => 10,
    'offset'               => '',
    'status'               => '',
    'type'                 => '',
    'currency'             => '',
    'user_id'              => '',
    'subscription_plan_id' => '',
    'profile_id'           => '',
    'transaction_id'       => '',
    'date'                 => '',
    'search'               => ''
);
 
$payments = pms_get_payments( $args );

Using this function you can grab a list of payments based on certain arguments.

Payments meta

Paid Member Subscriptions is using a meta system similar to WordPress Posts or Users for it’s custom payments. You can interact with it through the following functions:

pms_get_payment_meta( $payment_id = 0, $meta_key = '', $single = false );

$payment_id – id of the payment
$meta_key – key we want to retrieve
$single – if the function should return a single value or multiple

For more info see: https://developer.wordpress.org/reference/functions/get_metadata/

pms_add_payment_meta( $payment_id = 0, $meta_key = '', $meta_value = '', $unique = false );

$payment_id – id of the payment
$meta_key – key we want to add
$meta_value – value we want to add
$single – whether the specified metadata key should be unique for the object. If true, and the object already has a value for the specified metadata key, no change will be made

For more info see: https://developer.wordpress.org/reference/functions/add_metadata/

pms_update_payment_meta( $payment_id = 0, $meta_key = '', $meta_value = '', $prev_value = '' );

$payment_id – id of the payment
$meta_key – key we want to update
$meta_value – value we want to set
$prev_value – only update if existing value matches this field

For more info see: https://developer.wordpress.org/reference/functions/update_metadata/

pms_delete_payment_meta( $payment_id = 0, $meta_key = '', $meta_value = '', $delete_all = false );

$payment_id – id of the payment
$meta_key – key we want to delete
$meta_value – value we want to delete
$delete_all – If true, delete matching metadata entries for all payments, ignoring the specified payment_id. Otherwise, only delete matching metadata entries for the specified payment_id

For more info see: https://developer.wordpress.org/reference/functions/delete_metadata/

Subscriptions

Retrieve information about a subscription

$subscription = pms_get_member_subscription( $subscription_id );

This function will return a PMS_Member_Subscription object which contains information about a certain subscription. The object has the following keys:

id
user_id
subscription_plan_id
start_date
expiration_date
status
payment_profile_id
payment_gateway
billing_amount
billing_duration
billing_duration_unit
billing_cycles
billing_next_payment
billing_last_payment
trial_end

Get a list of subscriptions

$args = array(
  'order'                       => 'DESC',
  'orderby'                     => 'id',
  'number'                      => 1000,
  'offset'                      => '',
  'status'                      => '',
  'user_id'                     => '',
  'subscription_plan_id'        => '',
  'start_date'                  => '',
  'start_date_after'            => '',
  'start_date_before'           => '',
  'expiration_date'             => '',
  'expiration_date_after'       => '',
  'expiration_date_before'      => '',
  'billing_next_payment'        => '',
  'billing_next_payment_after'  => '',
  'billing_next_payment_before' => '',
  'include_abandoned'           => false,
);

$subscriptions = pms_get_member_subscriptions( $args );

Using this function you can grab a list of subscriptions based on certain arguments.

Subscription Plans

Retrieve information about a subscription plan

$subscription_plan = pms_get_subscription_plan( $subscription_plan_id );

This function will return a PMS_Subscription_Plan object which contains information about a particular subscription plan. The object has the following keys:

id
name
description
price
status
duration
duration_unit
user_role
top_parent
sign_up_fee
trial_duration
trial_duration_unit
recurring
type
fixed_membership
fixed_expiration_date
allow_renew

Retrieve a list of Subscription Plans

$only_active = true;
$include = array();
$exclude = array();

$subscription_plans = pms_get_subscription_plans( $only_active, $include, $exclude );

This function allows you to retrieve a list of all defined subscription plans.

Others

Get URL for a specific plugin page

This function let’s you retrieve the URL or ID of specific plugin pages.

$account_page = pms_get_page( 'account', true );

The first parameter can be:

login
account
register
lost-password

The second parameter determines if the function should return the ID of the page or it’s URL. Setting it to true will return the page URL.

Get URL for a specific Account action

The action links that are shown on the PMS Account page for members can also be generated programatically. For this there are different functions available:

pms_get_retry_url()
pms_get_abandon_url()
pms_get_cancel_url()
pms_get_renew_url()
pms_get_upgrade_url()

These functions will either return the action URL or false. False is being returned when the action is not available.

Each function can also take a parameter in the form of a $subscription_plan_id. This is useful if you are using the Multiple Subscriptions Per User add-on so you can target specific subscriptions.

The pms_get_upgrade_url() function will take you to the general Change Subscription page and depending on settings, the user could also Change or Downgrade their subscription plan from that page.

Get a list of users that are not members

$args = array(
    'orderby' => 'ID',
    'offset'  => '',
    'limit'   => ''
);
$non_member_users = pms_get_users_non_members( $args );

Retrieve an array of users that are not yet members on your website.

Get active currency

$currency = pms_get_active_currency();

Retrieve the active currency set on the Paid Member Subscriptions -> Settings -> Payments page.

Paid Member Subscriptions Pro

Accept (recurring) payments, create subscription plans and restrict content on your website. Easily setup a WordPress membership site using Paid Member Subscriptions.

Get Paid Member Subscriptions