PHPackages                             oofbar/membership - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Authentication & Authorization](/categories/authentication)
4. /
5. oofbar/membership

ActiveCraft-plugin[Authentication & Authorization](/categories/authentication)

oofbar/membership
=================

Give your users special access based on their Commerce Subscriptions.

3.0.1(8mo ago)45931[5 issues](https://github.com/oof-bar/craft-membership/issues)proprietaryPHPCI failing

Since Feb 26Pushed 8mo ago2 watchersCompare

[ Source](https://github.com/oof-bar/craft-membership)[ Packagist](https://packagist.org/packages/oofbar/membership)[ RSS](/packages/oofbar-membership/feed)WikiDiscussions v3 Synced 3w ago

READMEChangelogDependencies (2)Versions (9)Used By (0)

Membership Plugin for Craft Commerce
====================================

[](#membership-plugin-for-craft-commerce)

> Give your users special access based on their [Commerce subscriptions](https://craftcms.com/docs/commerce/5.x/system/subscriptions.html).

The Membership plugin works by listening to key [Subscription Events](https://craftcms.com/docs/commerce/5.x/extend/events.html#subscription-events) in Craft Commerce, and moving the subscriber into (or out of) groups based on rules or “grants” configured in the control panel.

Much of it could be implemented in a module specific to your application—this plugin is primarily intended for those who need a simple system for granting access based on active subscriptions, and do not wish to maintain that logic themselves.

The plugin handles creation, cancellation, and expiry of subscriptions, as well as switching of plans. At the moment, it does *not* support special access or restrictions based on “trial” periods.

Requirements
------------

[](#requirements)

This plugin requires Craft CMS 5 and Commerce 5. [Version 2.x](https://github.com/oof-bar/craft-membership/tree/v2) is compatible with Craft 4 and Commerce 4, and [version 1.x](https://github.com/oof-bar/craft-membership/tree/v1) works on Craft 3 and Commerce 3.

Warning

In order for subscriptions to work at all, **you must have Stripe webhooks configured**! Stripe has an excellent CLI to help [forward webhooks in development environments](https://stripe.com/docs/webhooks/test).

### Upgrading from Membership 2.x

[](#upgrading-from-membership-2x)

The 3.x upgrade should require no manual intervention, but it's always important to test your application for consistency.

There are only three functional changes:

- Logs are no longer shown on Subscription edit screens, by default. You must add the **Membership Logs** field layout element by visiting **Commerce** → **Settings** → **Subscription Fields**.
- A bug with grant validation was fixed, which may have allowed duplicate/identical grant configurations to exist in prior versions. The plugin now prevents saving grants that have the same plan *and* user group as another grant.
- A new **Manage grants** permission controls whether non-admin users can create, update, and delete grants.

Warning

Any user with this permission can use it to escalate their own access by creating a grant and then starting a Subscription. It is not granted to any users during the upgrade, and administrators will always be able to manage grants.

Installation
------------

[](#installation)

To install the plugin, follow these instructions (or just search “Membership” in the [Craft Plugin Store](https://plugins.craftcms.com/membership)):

1. Open your terminal and go to your Craft project:

    ```
    cd /path/to/project
    ```
2. Require the plugin with Composer:

    ```
    composer require oofbar/membership -w
    ```
3. In the control panel, go to **Settings** → **Plugins** and click the “Install” button for Membership, or run:

    ```
    php craft plugin/install membership
    ```

Details
-------

[](#details)

Each **grant** is a kind of policy or rule that maps **plans** to **user groups**. By default, the plugin doesn’t do anything—with no grants configured, it won’t make any changes to your users’ permissions as subscriptions begin and end.

Because Membership operates on user groups (not permissions, directly), it’s good to start by designing a sensible group-based permissions structure—for example, if your organization had *Bronze*, *Silver*, and *Gold* support tiers, you might create three user groups, and assign the relevant permissions to each.

You can create multiple grants per plan. For example, if you wanted to structure your permissions additively, you could grant *Gold* supporters access to all three groups. In this way, you can be sure that benefits granted to lower support tiers always bubble up to higher ones.

The plugin will never remove a user from a group that is granted by another of their active subscriptions: if `Plan A` and `Plan B` both move users into `Group 1`, but `Plan B` also adds users to `Group 2`, a subscription to `Plan B` expiring won’t remove the user from `Group 1` if their `Plan A` subscription is still active (and vice versa).

Note

Changing the configuration of a grant does *not* update existing users’ groups.

Usage
-----

[](#usage)

All configuration happens via the control panel. Go to the **Settings** section, and click on the **Membership** tile to manage grants.

Note

Grants are *not* stored in project config, and therefore must be configured in each environment. This is currently a [limitation](https://github.com/oof-bar/craft-membership/issues/5) of Commerce. You may need to navigate to the settings page directly, on your production environment—the path is always `settings/membership/grants`.

### Front-end

[](#front-end)

In your template, you can use the normal Craft user methods to check whether someone has a particular access level:

```
{% if currentUser.isInGroup('membersBronze') %}
    Thank you for your support! You have access to our entire lesson catalog.
{% endif %}
```

In addition to checking groups, you can also directly check permissions: For example, if the subscription(s) a user has aren’t as important as whether or not they have a certain capability, you can use the `.can()` method:

```
{% set section = craft.app.sections.getSectionByHandle('classifieds') %}

{% if currentUser.can("createEntries:#{section.uid}") %}
    You’re ready to create a listing!
{% endif %}
```

Warning

Automated management of user permissions via groups can be dangerous. Consider defining a [process or policy](https://putyourlightson.com/articles/securing-your-craft-site-in-2022-part-3) for reviewing and deploying changes to your project’s permissions scheme.

Auditing
--------

[](#auditing)

Membership has a lightweight logging system built-in so that store administrators have some visibility into what the plugin is doing. The `{{%membership_logs}}` table keeps track of any actions (successes and failures) taken by the plugin, and the relevant logs are available on the subscription’s edit screen via the **Membership logs** field layout element.

Extensibility
-------------

[](#extensibility)

Craft and Yii provide a rich system of [events](https://craftcms.com/docs/5.x/extend/events.html) to help developers alter the behavior of built-in and “pluggable” functionality.

Membership emits two events: one just before a permission is about to be granted, and one when a permission is about to be revoked. Keep in mind that these are *in addition to* Craft's own permissions events!

### `Permissions::EVENT_BEFORE_GRANT_PERMISSION`

[](#permissionsevent_before_grant_permission)

Raised just before a membership to a user group is granted. This is not emitted when a permission is not granted due to a user already being in a given group.

```
use yii\base\Event;

use oofbar\membership\services\Permissions;
use oofbar\membership\events\GrantPermission as GrantPermissionEvent;

Event::on(
    Permissions::class,
    Permissions::EVENT_BEFORE_GRANT_PERMISSION,
    function(GrantPermissionsEvent $event) {
        // Optionally: prevent the grant from occurring, based on some criteria!
        $event->isValid = false;
    }
);
```

The grant that resulted in the change is available as `$event->grant`, and from there, you can access the plan and user group via `$event->grant->getPlan()` and `$event->grant->getUserGroup()`.

### `Permissions::EVENT_BEFORE_REVOKE_PERMISSION`

[](#permissionsevent_before_revoke_permission)

Raised just before a user is removed from a user group. This is not emitted if a grant would remove a user from a group they weren’t in. Instead, Membership creates a [log](#auditing) message reflecting this state.

```
use yii\base\Event;

use oofbar\membership\services\Permissions;
use oofbar\membership\events\RevokePermission as RevokePermissionEvent;

Event::on(
    Permissions::class,
    Permissions::EVENT_BEFORE_REVOKE_PERMISSION,
    function(RevokePermissionsEvent $event) {
        // Optionally: prevent the revocation from occurring, based on some criteria!
        $event->isValid = false;
    }
);
```

The grant that resulted in the change is available as `$event->grant`, and from there, you can access the plan and user group via `$event->grant->getPlan()` and `$event->grant->getUserGroup()`.

🌳

###  Health Score

35

—

LowBetter than 77% of packages

Maintenance40

Moderate activity, may be stable

Popularity18

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity62

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~257 days

Recently: every ~224 days

Total

9

Last Release

251d ago

Major Versions

v1.x-dev → v2.0.02023-04-30

v2.x-dev → 3.0.02025-08-05

### Community

Maintainers

![](https://www.gravatar.com/avatar/344aa7464fb79111e85c3555e1b756b71ce3e268fb837efb4334029f0cea7d61?d=identicon)[oofbar](/maintainers/oofbar)

---

Top Contributors

[![AugustMiller](https://avatars.githubusercontent.com/u/1895522?v=4)](https://github.com/AugustMiller "AugustMiller (36 commits)")

---

Tags

craft-commercecraft-commerce-plugincraftcmscraftcms-plugincmssubscriptionsCraftcraftcmscraft-pluginmembershipcommerce

### Embed Badge

![Health badge](/badges/oofbar-membership/health.svg)

```
[![Health](https://phpackages.com/badges/oofbar-membership/health.svg)](https://phpackages.com/packages/oofbar-membership)
```

###  Alternatives

[verbb/events

A full-featured plugin for event management and ticketing.

2311.8k](/packages/verbb-events)[jamesedmonston/graphql-authentication

GraphQL authentication for your headless Craft CMS applications.

2917.3k](/packages/jamesedmonston-graphql-authentication)[saccilottoconsulting/craft-internal-assets

A simple plugin to restrict access to assets for permitted users only. Access to a given asset is only granted if the user has view-permissions for the given source (this can be set in the user- or group-settings). The asset source folder should be moved out of the web root folder so the files are never accessible without this plugin.

353.5k](/packages/saccilottoconsulting-craft-internal-assets)[verbb/gift-voucher

Sell and redeem digital gift vouchers for Craft Commerce.

1322.7k1](/packages/verbb-gift-voucher)[tomdiggle/craft-gatekeeper

Protect your Craft CMS website from access with a universal password.

109.3k](/packages/tomdiggle-craft-gatekeeper)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)