Purpose

Per-plugin licensing check. Returns the entitlement record for a specific MAM Suite plugin slug for the current customer site. Sibling plugins query this to decide whether to bootstrap.

Backed by mam_entitlement_manager (includes/plugin-update-manager/) and the WPMAM software-manager API. The entitlement record can include flags like blocked, expired, or trial.

Signature

$entitlement = apply_filters(
    'mam_plugin_entitlement',
    $default,
    string $plugin_slug
);

Returns: mixed — entitlement record (typically array) or the default.

Example: gate a sibling plugin’s bootstrap

add_action( 'plugins_loaded', function () {

    $entitlement = apply_filters( 'mam_plugin_entitlement', false, 'mam-my-plugin' );

    if ( ! $entitlement || ! empty( $entitlement['blocked'] ) ) {
        // Don't bootstrap — customer isn't entitled or has been blocked.
        return;
    }

    if ( ! empty( $entitlement['expired'] ) ) {
        // Show an admin notice; don't bootstrap functional code.
        add_action( 'admin_notices', 'my_plugin_expired_notice' );
        return;
    }

    // Normal bootstrap.
    new MAM_My_Plugin_Manager();
} );

This is the pattern mam-geodirectory and other sibling plugins use to decide whether to register their hooks.

Entitlement record shape

The exact shape depends on what WPMAM returns for the customer’s account code. Typical keys:

How it resolves

mam_plugin_entitlement filter is applied
      │
      ▼
mam_entitlement_manager checks the cached entitlement map
      │ (cache is per-account-code, refreshed periodically)
      ▼
Cache miss → WPMAM software-manager API call
      │ POSTs account code, receives entitlement map
      ▼
Persist + return the per-plugin record

Related: mam_check_required_version

Sibling plugins also commonly check that mam-main is at a sufficient version:

$ok = apply_filters( 'mam_check_required_version', false, 'mam-main', '1.9.1' );

Gotchas

• Cache is per-account-code. Switching account codes (rare — should never happen on a live site) requires a cache flush.
• Network failures produce stale entitlement reads. The graceful-degradation hook (see MAM_Account_Code_Manager patterns) applies — defaults often assume “still entitled” during planned outages.
• Don’t gate every request by re-firing this filter at request-time; bootstrap-time check is enough. Fire it once on plugins_loaded and cache the decision.
• Customer-side blocking is admin/support territory. Don’t try to “auto-recover” from a blocked entitlement.
• The default value controls the no-record path. Default false means “not entitled if WPMAM has no record.”

Related articles

• Integration: Account code and enrollment server
• Recipe: Customer enrollment and account code
• Frozen public contracts reference

Metadata