Restrict Content Pro
rcp_get_memberships()
Coming soon: Restrict Content Pro is becoming Kadence Memberships. You may see both names used while we update the product, documentation, and customer experience.
Note: This content is provided as a resource within our developer documentation. Because custom code requires highly specific implementation, we encourage you to work with a qualified developer if you need guidance. You can find our recommended consultants here: https://codeable.io/developers/restrict-content-pro
Query for memberships.
Parameters
$args (array) – All optional:
$id (int) – Single membership ID.$id__in,Â$id__not_in (array) – Include or exclude membership IDs.$customer_id (int) – This customer’s memberships only.$customer_id__in,Â$customer_id__not_in (array) – Customer ID filters.$object_id (int) – Membership level ID.$object_id__in,Â$object_id__not_in (array) – Level ID filters.$object_type (string) – Object type filter.$object_type__in,Â$object_type__not_in (array) – Object type filters.$currency (string) – Currency code.$created_date_query,Â$trial_end_date_query,Â$cancellation_date_query,Â$expiration_date_query (array) – See WP_Date_Query.$auto_renew (int) –Â1 recurring,Â0 not; default null.$status (string) –Âpending,Âactive,Âcancelled,Âexpired.$status__in,Â$status__not_in (array) – Status filters.$gateway_customer_id,Â$gateway_subscription_id,Â$gateway,Â$subscription_key (string).$upgraded_from (int) – Upgraded-from membership ID.$disabled (int|null) –Ânull all,Â0 enabled only (default),Â1 disabled only.$meta_query (array) – Meta query arrays (array of arrays).$count (bool) – Count vs objects; default false.$fields (string) – Column name or empty for full objects.$number (int) – Limit; default 20.$offset (int) – Offset; default 0 (not 20).$no_found_rows (bool) – DisableÂSQL_CALC_FOUND_ROWS; default true.$orderby,Â$order (string) – Sort; defaultÂid /ÂDESC.$search (string).$update_cache (bool) – Prime cache; default false.
Return values
(array) – RCP_Membership objects.
Examples
Active memberships:
$memberships = rcp_get_memberships( array(
'status' => 'active'
) );
Expired on level #3:
$memberships = rcp_get_memberships( array(
'object_id' => 3,
'status' => 'expired'
) );
Five Stripe memberships:
$memberships = rcp_get_memberships( array(
'number' => 5,
'gateway' => 'stripe'
) );
Expire memberships in a December 2024 window:
$memberships = rcp_get_memberships( array(
'expiration_date_query' => array(
'after' => date( '2024-12-01 00:00:00', current_time( 'timestamp' ) ),
'before' => date( '2024-12-31 23:59:59', current_time( 'timestamp' ) ),
),
'number' => 9999
) );
if ( ! empty( $memberships ) ) {
foreach ( $memberships as $membership ) {
$membership->expire();
}
}
Cancel auto-renew on active memberships:
$memberships = rcp_get_memberships( array(
'status' => 'active',
'auto_renew' => 1,
'number' => 9999
) );
if ( ! empty( $memberships ) ) {
foreach ( $memberships as $membership ) {
if ( $membership->can_cancel() ) {
$membership->cancel_payment_profile();
}
}
}
Active memberships with meta company = Sandhills:
$memberships = rcp_get_memberships( array(
'status' => 'active',
'number' => 9999,
'meta_query' => array(
array(
'key' => 'company',
'value' => 'Sandhills',
)
)
) );