OMembership v1.0.0

Requirements

• WordPress 6.0 or newer
• PHP 8.0 or newer
• HTTPS (required for Stripe and for cookie-based session security)
• A Stripe account, a PayPal account, or both (only required for paid plans)
• WooCommerce is optional. If installed, OMembership can hook into Woo products as membership entry points.

From WordPress admin

Plan types

Capabilities

A capability is a short string attached to a plan. Use them as the unit of access; access rules check capabilities, not plan names. Adding read_premium to two plans means any rule referencing read_premium grants both plans access. This decouples your content rules from your pricing.

PHP// Read capabilities for the current user
$caps = OM_Capabilities::for_user( get_current_user_id() );
// e.g. ['read_premium', 'download_assets', 'forum_pro']

if ( in_array( 'read_premium', $caps, true ) ) {
    // user can read premium content
}

// Or as a single check
if ( omembership_user_can( 'read_premium' ) ) { /* ... */ }

Trials & coupons

Rule shape

PHP// Create an access rule programmatically
OM_Access_Rules::save([
    'source_type'   => 'category',           // post | category | tag | cpt | custom
    'source_value'  => 'premium',             // slug, ID, or filter callback name
    'required_caps' => [ 'read_premium' ],    // any one match grants access
    'action'        => 'block',               // block | teaser | blur | replace | drip
    'teaser_words'  => 60,                    // for action=teaser
    'replace_post'  => 0,                     // post ID to swap in for action=replace
    'cta_text'      => 'Subscribe to read',
    'cta_url'       => '/pricing',
]);

Actions

Drip schedules

PHP// Drip lesson 3 to a course member 14 days after signup
OM_Drip::save([
    'plan_id'      => 7,
    'post_id'      => 142,           // a lesson inside a course
    'mode'         => 'relative',     // relative | absolute | event
    'offset_days'  => 14,
    'offset_basis' => 'signup',       // signup | first_payment | enrollment
]);

// Or: unlock everything on a fixed calendar date
OM_Drip::save([
    'plan_id'  => 7,
    'post_id'  => 142,
    'mode'     => 'absolute',
    'unlock_at'=> '2026-08-01 00:00:00',
]);

Evaluation order

• 1Find all rules that match the current post (source_type and source_value).
• 2If the user is an admin or has the omembership_bypass capability, grant access immediately.
• 3For each matching rule, collect required_caps.
• 4Resolve the user's capabilities via active subscriptions (OM_Capabilities::for_user()).
• 5If the user holds at least one required capability, grant access.
• 6If the rule action is drip, additionally check that the drip schedule has unlocked.
• 7Otherwise apply the rule's action (block / teaser / blur / replace).

Stripe

Supported Stripe events: checkout.session.completed, customer.subscription.created, customer.subscription.updated, customer.subscription.deleted, invoice.payment_succeeded, invoice.payment_failed, charge.refunded.

PayPal

OMembership uses PayPal Subscriptions (REST v2). The flow returns to /membership/return/ with a subscription_id, which OMembership resolves against the PayPal API to confirm the subscription state before granting access.

Supported PayPal events: BILLING.SUBSCRIPTION.CREATED, BILLING.SUBSCRIPTION.ACTIVATED, BILLING.SUBSCRIPTION.UPDATED, BILLING.SUBSCRIPTION.CANCELLED, PAYMENT.SALE.COMPLETED, PAYMENT.SALE.REFUNDED.

Dunning

When a renewal payment fails, OMembership marks the subscription past_due and starts the dunning sequence. By default: retry on day 1, day 3, day 7. After the final attempt, the subscription transitions to canceled and the member loses access. The schedule and email templates are configurable under Payments → Dunning.

PHP// Customise retry schedule
add_filter( 'omembership_dunning_schedule', function( array $days ): array {
    return [ 1, 3, 5, 10, 14 ];   // days after the failed charge
} );

Built-in tabs

Shortcodes

HTML[omembership_portal]
[omembership_portal tabs="dashboard,content,billing"]
[omembership_portal theme="midnight"]
[omembership_pricing]
[omembership_login redirect="/membership/"]
[omembership_signup plan_id="3"]
[omembership_gate cap="read_premium"]
Premium-only HTML goes here.
[/omembership_gate]

Custom tabs

PHPadd_filter( 'omembership_portal_tabs', function( array $tabs ): array {
    $tabs['my_downloads'] = [
        'label'  => 'My Downloads',
        'icon'   => 'download',
        'cap'    => 'download_assets',     // optional capability gate
        'render' => function( int $user_id ): string {
            ob_start();
            include get_template_directory() . '/parts/member-downloads.php';
            return ob_get_clean();
        },
    ];
    return $tabs;
} );

Endpoints

Check access

cURLcurl -X GET 'https://example.com/wp-json/omembership/v1/access/check?post=142' \
  -H 'X-WP-Nonce: <rest-nonce>'

# Response
{
  "allowed":      false,
  "reason":       "drip_locked",
  "unlock_at":    "2026-06-20 00:00:00",
  "required_caps":["read_premium"],
  "user_caps":    ["read_premium"]
}

Start checkout

cURLcurl -X POST https://example.com/wp-json/omembership/v1/checkout \
  -H 'Content-Type: application/json' \
  -H 'X-WP-Nonce: <rest-nonce>' \
  -d '{
    "plan_id":    3,
    "gateway":    "stripe",
    "coupon":     "LAUNCH20",
    "return_url": "https://example.com/membership/"
  }'

# Response
{ "redirect_url": "https://checkout.stripe.com/c/pay/cs_..." }