eventespresso / event-espresso-core

PaymentMethods/PayPalCommerce/modules/EED_PayPalOnboard.module.php

Indentation +669 added lines, -669 removed lines

@@ -20,673 +20,673 @@
  */
 class EED_PayPalOnboard extends EED_Module
 {
-    /**
-     * @return EED_Module
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance(): EED_Module
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * Run - initial module setup.
-     *
-     * @param WP $WP
-     * @return void
-     */
-    public function run($WP)
-    {
-    }
-
-
-    /**
-     * For hooking into EE Admin Core and other modules.
-     *
-     * @return void
-     */
-    public static function set_hooks_admin(): void
-    {
-        if (DbStatus::isOnline()) {
-            // Get onboarding URL.
-            add_action('wp_ajax_eeaPpGetOnboardingUrl', [__CLASS__, 'getOnboardingUrl']);
-            // Catch the return/redirect from PayPal onboarding page.
-            add_action('init', [__CLASS__, 'updateOnboardingStatus'], 10);
-            // Return the connection/onboard status.
-            add_action('wp_ajax_eeaPpGetOnboardStatus', [__CLASS__, 'getOnboardStatus']);
-            // Revoke access.
-            add_action('wp_ajax_eeaPpOffboard', [__CLASS__, 'offboard']);
-            // Admin notice.
-            add_action('admin_init', [__CLASS__, 'adminNotice']);
-        }
-    }
-
-
-    /**
-     * Get the onboarding URL.
-     * (AJAX)
-     *
-     * @return void
-     */
-    public static function getOnboardingUrl(): void
-    {
-        $signup_link = '';
-        try {
-            $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-            if (! $paypal_pm instanceof EE_Payment_Method) {
-                PayPalLogger::errorLogAndExit(
-                    esc_html__('No payment method.', 'event_espresso'),
-                    EED_Module::getRequest()->postParams(),
-                    $paypal_pm
-                );
-            }
-            PayPalExtraMetaManager::updateDebugMode($paypal_pm, EED_Module::getRequest()->postParams());
-            // $signup_link   = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL);
-            // $token_expired = EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm);
-            // if (! $signup_link || $token_expired) {
-            $signup_link = EED_PayPalOnboard::requestOnboardingUrl($paypal_pm);
-            // }
-            if (! $signup_link) {
-                $err_msg = esc_html__('Error! Could not generate a sign-up link.', 'event_espresso');
-                PayPalLogger::errorLogAndExit($err_msg, ['signup_link' => $signup_link], $paypal_pm);
-            }
-            PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL, $signup_link);
-        } catch (Exception $exception) {
-            PayPalLogger::errorLogAndExit($exception->getMessage());
-        }
-        // Is it empty (can happen if we didn't get the URL through the API).
-        $signup_link = $signup_link ? $signup_link . '?&displayMode=minibrowser' : '#';
-        wp_send_json(
-            [
-                'signup_link' => $signup_link,
-            ]
-        );
-    }
-
-
-    /**
-     * Request the sign-up link from PayPal.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param bool              $one_time_request
-     * @return string
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public static function requestOnboardingUrl(EE_Payment_Method $paypal_pm, bool $one_time_request = false): string
-    {
-        $signup_link = '';
-        // Get the access token.
-        $access_token = EED_PayPalOnboard::getPartnerAccessToken($paypal_pm);
-        if (! $access_token) {
-            $err_msg = esc_html__('Error! No access token.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, ['access_token' => $access_token], $paypal_pm);
-            return '';
-        }
-        // Request the access token.
-        $body_params = EED_PayPalOnboard::signupLinkRequestBody($paypal_pm);
-        $bn_code     = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
-        $post_params = [
-            'method'  => 'POST',
-            'headers' => [
-                'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
-                'Content-Type'                  => 'application/json',
-                'Authorization'                 => 'Bearer ' . $access_token,
-                'PayPal-Partner-Attribution-Id' => $bn_code,
-            ],
-            'body'    => $body_params,
-        ];
-        $request_url = Domain::getPayPalApiUrl($paypal_pm) . '/v2/customer/partner-referrals';
-        $response    = EED_PayPalOnboard::sendRequest($paypal_pm, $request_url, $post_params);
-        // Check the data we received.
-        if (isset($response['error']) || empty($response['links'])) {
-            // Did the original access token get replaced by any chance ?
-            if (! $one_time_request
-                && ! empty($response['message'])
-                && $response['message'] === 'Access Token not found in cache'
-            ) {
-                // Clear all PM metadata and try getting the access token One more time.
-                PayPalExtraMetaManager::deleteAllData($paypal_pm);
-                return EED_PayPalOnboard::requestOnboardingUrl($paypal_pm, true);
-            }
-            $err_msg = esc_html__('Incoming sign-up link parameter validation failed.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, $response, $paypal_pm);
-            return '';
-        }
-        // Now retrieve that sign-up link.
-        foreach ($response['links'] as $link) {
-            if ($link['rel'] === 'action_url') {
-                $signup_link = $link['href'] ?? '';
-            }
-        }
-        return $signup_link;
-    }
-
-
-    /**
-     * Get the return URL.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws Exception
-     */
-    public static function signupLinkRequestBody(EE_Payment_Method $paypal_pm): string
-    {
-        $identifier_string = new OneTimeString($paypal_pm->debug_mode());
-        $tracking_id       = $identifier_string->value();
-        $request           = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $checkout_type     = $request->getRequestParam('checkout_type', 'EXPRESS_CHECKOUT', DataType::STRING);
-        // Save the identifier for future use.
-        PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_TRACKING_ID, $tracking_id);
-        // Assemble the return URL.
-        $return_url = EED_PayPalOnboard::getReturnUrl($paypal_pm);
-        return json_encode([
-            'tracking_id'             => $tracking_id,
-            'operations'              => [
-                [
-                    'operation'                  => 'API_INTEGRATION',
-                    'api_integration_preference' => [
-                        'rest_api_integration' => [
-                            'integration_method'  => 'PAYPAL',
-                            'integration_type'    => 'THIRD_PARTY',
-                            'third_party_details' => [
-                                'features' => ['PAYMENT', 'REFUND'],
-                            ],
-                        ],
-                    ],
-                ],
-            ],
-            'products'                => [$checkout_type],
-            'legal_consents'          => [
-                [
-                    'type'    => 'SHARE_DATA_CONSENT',
-                    'granted' => true,
-                ],
-            ],
-            'partner_config_override' => [
-                'return_url' => $return_url,
-            ],
-        ]);
-    }
-
-
-    /**
-     * Get the return URL.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getReturnUrl(EE_Payment_Method $paypal_pm): string
-    {
-        $wp_nonce = EED_Module::getRequest()->getRequestParam('wp_nonce');
-        $nonce    = wp_create_nonce(Domain::NONCE_NAME_ONBOARDING_RETURN);
-        return add_query_arg(
-            [
-                'page'                        => 'espresso_payment_settings',
-                'webhook_action'              => 'eea_pp_commerce_merchant_onboard',
-                'payment_method'              => $paypal_pm->slug(),
-                '_wpnonce'                    => $wp_nonce,
-                'nonce'                       => $nonce,
-                Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
-            ],
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Redirect to the payment method (PP) settings home page.
-     *
-     * @return void
-     */
-    public static function redirectToPmSettingsHome(): void
-    {
-        $get_params = EED_Module::getRequest()->getParams();
-        if (empty($get_params['payment_method'])) {
-            // Simply do not redirect.
-            return;
-        }
-        $args_to_add = [
-            'page'           => 'espresso_payment_settings',
-            'payment_method' => $get_params['payment_method'],
-        ];
-        if (isset($get_params['sandbox_mode'])) {
-            $args_to_add[ Domain::META_KEY_SANDBOX_MODE ] = $get_params['sandbox_mode'];
-        }
-        $home_url = add_query_arg($args_to_add, admin_url('admin.php'));
-        wp_redirect($home_url);
-        exit;
-    }
-
-
-    /**
-     * Check user’s onboarding status.
-     * This will handle the user return from the auth page and also check the status via the API.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function updateOnboardingStatus(): void
-    {
-        // Check if this is the webhook from PayPal.
-        if (! isset($_GET['webhook_action'], $_GET['nonce'])
-            || $_GET['webhook_action'] !== 'eea_pp_commerce_merchant_onboard'
-        ) {
-            return;  // Ignore.
-        }
-        $get_params = EED_Module::getRequest()->getParams();
-        // Get the payment method.
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        // Check the response (GET) parameters.
-        if (! EED_PayPalOnboard::onboardingStatusResponseValid($get_params, $paypal_pm)) {
-            // Missing parameters. Can't proceed.
-            PayPalLogger::errorLog(
-                esc_html__('Missing required onboarding parameters.', 'event_espresso'),
-                $get_params,
-                $paypal_pm
-            );
-            EED_PayPalOnboard::redirectToPmSettingsHome();
-            return;
-        }
-        // Were the requested permissions granted ?
-        if (empty($get_params[ Domain::API_PARAM_PERMISSIONS_GRANTED ])) {
-            $error_message = esc_html__(
-                'Permissions not granted by merchant or email not confirmed.',
-                'event_espresso'
-            );
-            PayPalLogger::errorLog($error_message, $get_params, $paypal_pm);
-            EED_PayPalOnboard::redirectToPmSettingsHome();
-            return;
-        }
-        // Check on the onboarding status (recommended by PP).
-        $onboarding_status = EED_PayPalOnboard::trackSellerOnboarding(
-            $paypal_pm,
-            $get_params[ Domain::META_KEY_SELLER_MERCHANT_ID ]
-        );
-        if (! isset($onboarding_status['valid']) || ! $onboarding_status['valid']) {
-            PayPalLogger::errorLog(
-                $onboarding_status['message'],
-                array_merge($get_params, $onboarding_status),
-                $paypal_pm
-            );
-            EED_PayPalOnboard::redirectToPmSettingsHome();
-            return;
-        }
-        // Start saving the setup and info.
-        PayPalExtraMetaManager::parseAndSaveOptions($paypal_pm, $onboarding_status);
-        // Save the credentials.
-        PayPalExtraMetaManager::saveSellerApiCredentials($paypal_pm, $get_params);
-        // If onboarded successfully, remove the onboarding URL.
-        PayPalExtraMetaManager::deletePmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL);
-        // Also clen GET params by redirecting, because PP auto redirects to the return_url on closing the onboarding window.
-        EED_PayPalOnboard::redirectToPmSettingsHome();
-    }
-
-
-    /**
-     * Check if all required parameters for the onboarding status check are present.
-     *
-     * @param array $data
-     * @param mixed $paypal_pm
-     * @return bool
-     */
-    public static function onboardingStatusResponseValid(array $data, $paypal_pm): bool
-    {
-        // Check that we have all the required parameters and the nonce is ok.
-        if ($paypal_pm instanceof EE_Payment_Method
-            && wp_verify_nonce($data['nonce'], Domain::NONCE_NAME_ONBOARDING_RETURN)
-            && ! empty($data[ Domain::API_PARAM_PARTNER_ID ])
-            && ! empty($data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
-            && isset($data[ Domain::API_PARAM_PERMISSIONS_GRANTED ])
-            && isset($data[ Domain::API_PARAM_EMAIL_CONFIRMED ])
-        ) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Get partner access token.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getPartnerAccessToken(EE_Payment_Method $paypal_pm): string
-    {
-        // Do we have it saved ?
-        $access_token = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ACCESS_TOKEN);
-        $expired      = EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm);
-        // If we don't have it, request/update it.
-        if (! $access_token || $expired) {
-            return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
-        }
-        // Access token is saved as encrypted, so return decrypted.
-        return $access_token;
-    }
-
-
-    /**
-     * Get partner access token.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     */
-    public static function partnerAccessTokenExpired(EE_Payment_Method $paypal_pm): bool
-    {
-        $expires_at = (int) PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_EXPIRES_IN);
-        if (! $expires_at) {
-            return true;
-        }
-        // Validate the token expiration date.
-        $now          = time();
-        $minutes_left = round(($expires_at - $now) / 60);
-        // Count as expired if less than 60 minutes till expiration left.
-        if ($minutes_left <= 60) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Request the partner access token from PayPal and save/update it.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function requestPartnerAccessToken(EE_Payment_Method $paypal_pm): string
-    {
-        $nonce = wp_create_nonce('eea_pp_commerce_get_access_token');
-        // Request the access token.
-        $post_args = [
-            'method' => 'POST',
-            'body'   => [
-                'nonce'                       => $nonce,
-                'api_version'                 => 'v1',
-                Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
-            ],
-        ];
-        if (defined('LOCAL_MIDDLEMAN_SERVER')) {
-            $post_args['sslverify'] = false;
-        }
-        $post_url = EED_PayPalOnboard::getMiddlemanBaseUrl($paypal_pm) . 'get_token';
-        $response = EED_PayPalOnboard::sendRequest($paypal_pm, $post_url, $post_args);
-        if (isset($response['error'])) {
-            return '';
-        }
-        // Check the data we received.
-        if (! EED_PayPalOnboard::partnerTokenResponseValid($response, $paypal_pm)) {
-            return '';
-        }
-        // If we are here all seems to be ok. Save the token and it's data.
-        $saved = PayPalExtraMetaManager::savePartnerAccessToken($paypal_pm, $response);
-        if (! $saved) {
-            return '';
-        }
-        return $response['access_token'];
-    }
-
-
-    /**
-     * Request seller onboarding status from PayPal.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $merchant_id
-     * @return array
-     */
-    public static function trackSellerOnboarding(EE_Payment_Method $paypal_pm, string $merchant_id): array
-    {
-        $track_onboarding = EED_PayPalOnboard::getTrackOnboardingApi($paypal_pm, $merchant_id);
-        if (! $track_onboarding instanceof TrackSellerOnboarding) {
-            $err_msg = esc_html__('Failed to track seller onboarding.', 'event_espresso');
-            return ['error' => 'TRACK_ONBOARDING_FAILED', 'message' => $err_msg];
-        }
-        return $track_onboarding->isValid();
-    }
-
-
-    /**
-     * Returns the Track Seller Onboarding API.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $merchant_id
-     * @return TrackSellerOnboarding|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getTrackOnboardingApi(
-        EE_Payment_Method $paypal_pm,
-        string            $merchant_id
-    ): ?TrackSellerOnboarding {
-        $partner_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_MERCHANT_ID);
-        $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi || ! $partner_id) {
-            return null;
-        }
-        return new TrackSellerOnboarding($paypal_api, $partner_id, $merchant_id, $paypal_pm->debug_mode());
-    }
-
-
-    /**
-     * Check the onboard status and return the result.
-     * (AJAX)
-     *
-     * @return void
-     */
-    public static function getOnboardStatus(): void
-    {
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
-            $err_msg = esc_html__('Could not specify the payment method.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, EED_Module::getRequest()->postParams(), $paypal_pm);
-            wp_send_json(['on_board' => false]);
-        }
-        try {
-            $seller_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_SELLER_MERCHANT_ID) ?? '--';
-        } catch (Exception $e) {
-            $seller_id = '--';
-        }
-        wp_send_json(
-            [
-                'on_board'  => EED_PayPalOnboard::isOnboard($paypal_pm),
-                'seller_id' => $seller_id,
-            ]
-        );
-    }
-
-
-    /**
-     * De-authorize the seller. Remove all API credentials.
-     * (AJAX)
-     *
-     * @return void
-     */
-    public static function offboard(): void
-    {
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
-            wp_send_json([
-                'error'   => 'INVALID_PM',
-                'message' => esc_html__(
-                    'Invalid payment method. Please refresh the page and try again.',
-                    'event_espresso'
-                ),
-            ]);
-        }
-        PayPalExtraMetaManager::deleteAllData($paypal_pm);
-        wp_send_json(['success' => true]);
-    }
-
-
-    /**
-     * Checks if already onboard.
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return boolean
-     */
-    public static function isOnboard(EE_Payment_Method $payment_method): bool
-    {
-        $pp_meta_data = PayPalExtraMetaManager::getAllData($payment_method);
-        return
-            // onborded with a third party integration ?
-            (! empty($pp_meta_data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_ACCESS_TOKEN ])
-            )
-            // or with the first party integration ?
-            || (! empty($pp_meta_data[ Domain::META_KEY_CLIENT_ID ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_CLIENT_SECRET ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_PAYER_ID ])
-            );
-    }
-
-
-    /**
-     * Send a request and return a decoded response body.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $request_url
-     * @param array             $request_args
-     * @return array
-     */
-    public static function sendRequest(EE_Payment_Method $paypal_pm, string $request_url, array $request_args): array
-    {
-        $error_return = ['error' => true];
-        $response     = wp_remote_request($request_url, $request_args);
-        if (is_wp_error($response)) {
-            $message = $response->get_error_message();
-            PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
-            $error_return['message'] = $message;
-            return $error_return;
-        }
-        $response_body = (isset($response['body']) && $response['body']) ? json_decode($response['body'], true) : [];
-        if (empty($response_body) || isset($response_body['error'])) {
-            $message = $response_body['error_description']
-                       ?? sprintf(
-                           esc_html__('Unknown response received while sending a request to: %1$s', 'event_espresso'),
-                           $request_url
-                       );
-            PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
-            $error_return['message'] = $message;
-            return $error_return;
-        }
-        return $response_body;
-    }
-
-
-    /**
-     * Check the response for a partner token request.
-     *
-     * @param                   $response
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     */
-    public static function partnerTokenResponseValid($response, EE_Payment_Method $paypal_pm): bool
-    {
-        // Check the data we received.
-        if (
-            empty($response['nonce'])
-            || ! wp_verify_nonce($response['nonce'], 'eea_pp_commerce_get_access_token')
-            || empty($response['access_token'])
-            || empty($response['app_id'])
-            || empty($response['expires_in'])
-            || empty($response['partner_client_id'])
-            || empty($response['partner_merchant_id'])
-        ) {
-            // This is an error.
-            $err_msg = esc_html__('Incoming parameter validation failed.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, (array) $response, $paypal_pm);
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * Returns the base URL to the middleman server.
-     * If LOCAL_MIDDLEMAN_SERVER is defined, requests will be sent to connect.eventespresso.test
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getMiddlemanBaseUrl(EE_Payment_Method $payment_method): string
-    {
-        $target = defined('LOCAL_MIDDLEMAN_SERVER') ? 'test' : 'com';
-        // If this PM is used under different provider accounts, you might need an account indicator.
-        $account = defined('EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR') ? EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR : '';
-        $postfix = $payment_method->debug_mode() ? '_sandbox' : '';
-        $path    = 'paypal_commerce' . $account . $postfix;
-        return 'https://connect.eventespresso.' . $target . '/' . $path . '/';
-    }
-
-
-    /**
-     * This Payment Method admin notices.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function adminNotice()
-    {
-        // A notice to re-connect if still connected through the first party integration.
-        $pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
-        // Show the notice only if PayPal Commerce is active.
-        if (! $pp_commerce instanceof EE_Payment_Method
-            || ! EED_PayPalOnboard::isOnboard($pp_commerce)
-            || EED_PayPalCommerce::isThirdParty($pp_commerce)
-        ) {
-            return;
-        }
-        add_action('admin_notices', [__CLASS__, 'reConnectNotice']);
-    }
-
-
-    /**
-     * Re-connect notice contents.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function reConnectNotice()
-    {
-        $open_anchor = $close_anchor = '';
-        $pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
-        if ($pp_commerce instanceof EE_Payment_Method) {
-            $pm_page = add_query_arg(
-                [
-                    'page'           => 'espresso_payment_settings',
-                    'webhook_action' => 'eea_pp_commerce_merchant_onboard',
-                    'payment_method' => $pp_commerce->slug(),
-                ],
-                admin_url('admin.php')
-            );
-            $open_anchor  = "<a href='$pm_page'>";
-            $close_anchor = "</a>";
-        }
-        echo '<div class="error"><p>'
-        . sprintf(
-            esc_html__(
-                '%1$sPayPal Commerce%2$s has updated the API integration type to allow more flexibility with payments. Please disconnect and re-Connect on the %3$sPayment Methods admin%4$s page to update the credentials and allow advanced payment type options.',
-                'event_espresso'
-            ),
-            '<strong>',
-            '</strong>',
-            $open_anchor,
-            $close_anchor
-         )
-         . '</p></div>';
-    }
+	/**
+	 * @return EED_Module
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance(): EED_Module
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * Run - initial module setup.
+	 *
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function run($WP)
+	{
+	}
+
+
+	/**
+	 * For hooking into EE Admin Core and other modules.
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin(): void
+	{
+		if (DbStatus::isOnline()) {
+			// Get onboarding URL.
+			add_action('wp_ajax_eeaPpGetOnboardingUrl', [__CLASS__, 'getOnboardingUrl']);
+			// Catch the return/redirect from PayPal onboarding page.
+			add_action('init', [__CLASS__, 'updateOnboardingStatus'], 10);
+			// Return the connection/onboard status.
+			add_action('wp_ajax_eeaPpGetOnboardStatus', [__CLASS__, 'getOnboardStatus']);
+			// Revoke access.
+			add_action('wp_ajax_eeaPpOffboard', [__CLASS__, 'offboard']);
+			// Admin notice.
+			add_action('admin_init', [__CLASS__, 'adminNotice']);
+		}
+	}
+
+
+	/**
+	 * Get the onboarding URL.
+	 * (AJAX)
+	 *
+	 * @return void
+	 */
+	public static function getOnboardingUrl(): void
+	{
+		$signup_link = '';
+		try {
+			$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+			if (! $paypal_pm instanceof EE_Payment_Method) {
+				PayPalLogger::errorLogAndExit(
+					esc_html__('No payment method.', 'event_espresso'),
+					EED_Module::getRequest()->postParams(),
+					$paypal_pm
+				);
+			}
+			PayPalExtraMetaManager::updateDebugMode($paypal_pm, EED_Module::getRequest()->postParams());
+			// $signup_link   = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL);
+			// $token_expired = EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm);
+			// if (! $signup_link || $token_expired) {
+			$signup_link = EED_PayPalOnboard::requestOnboardingUrl($paypal_pm);
+			// }
+			if (! $signup_link) {
+				$err_msg = esc_html__('Error! Could not generate a sign-up link.', 'event_espresso');
+				PayPalLogger::errorLogAndExit($err_msg, ['signup_link' => $signup_link], $paypal_pm);
+			}
+			PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL, $signup_link);
+		} catch (Exception $exception) {
+			PayPalLogger::errorLogAndExit($exception->getMessage());
+		}
+		// Is it empty (can happen if we didn't get the URL through the API).
+		$signup_link = $signup_link ? $signup_link . '?&displayMode=minibrowser' : '#';
+		wp_send_json(
+			[
+				'signup_link' => $signup_link,
+			]
+		);
+	}
+
+
+	/**
+	 * Request the sign-up link from PayPal.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param bool              $one_time_request
+	 * @return string
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public static function requestOnboardingUrl(EE_Payment_Method $paypal_pm, bool $one_time_request = false): string
+	{
+		$signup_link = '';
+		// Get the access token.
+		$access_token = EED_PayPalOnboard::getPartnerAccessToken($paypal_pm);
+		if (! $access_token) {
+			$err_msg = esc_html__('Error! No access token.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, ['access_token' => $access_token], $paypal_pm);
+			return '';
+		}
+		// Request the access token.
+		$body_params = EED_PayPalOnboard::signupLinkRequestBody($paypal_pm);
+		$bn_code     = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
+		$post_params = [
+			'method'  => 'POST',
+			'headers' => [
+				'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
+				'Content-Type'                  => 'application/json',
+				'Authorization'                 => 'Bearer ' . $access_token,
+				'PayPal-Partner-Attribution-Id' => $bn_code,
+			],
+			'body'    => $body_params,
+		];
+		$request_url = Domain::getPayPalApiUrl($paypal_pm) . '/v2/customer/partner-referrals';
+		$response    = EED_PayPalOnboard::sendRequest($paypal_pm, $request_url, $post_params);
+		// Check the data we received.
+		if (isset($response['error']) || empty($response['links'])) {
+			// Did the original access token get replaced by any chance ?
+			if (! $one_time_request
+				&& ! empty($response['message'])
+				&& $response['message'] === 'Access Token not found in cache'
+			) {
+				// Clear all PM metadata and try getting the access token One more time.
+				PayPalExtraMetaManager::deleteAllData($paypal_pm);
+				return EED_PayPalOnboard::requestOnboardingUrl($paypal_pm, true);
+			}
+			$err_msg = esc_html__('Incoming sign-up link parameter validation failed.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, $response, $paypal_pm);
+			return '';
+		}
+		// Now retrieve that sign-up link.
+		foreach ($response['links'] as $link) {
+			if ($link['rel'] === 'action_url') {
+				$signup_link = $link['href'] ?? '';
+			}
+		}
+		return $signup_link;
+	}
+
+
+	/**
+	 * Get the return URL.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws Exception
+	 */
+	public static function signupLinkRequestBody(EE_Payment_Method $paypal_pm): string
+	{
+		$identifier_string = new OneTimeString($paypal_pm->debug_mode());
+		$tracking_id       = $identifier_string->value();
+		$request           = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$checkout_type     = $request->getRequestParam('checkout_type', 'EXPRESS_CHECKOUT', DataType::STRING);
+		// Save the identifier for future use.
+		PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_TRACKING_ID, $tracking_id);
+		// Assemble the return URL.
+		$return_url = EED_PayPalOnboard::getReturnUrl($paypal_pm);
+		return json_encode([
+			'tracking_id'             => $tracking_id,
+			'operations'              => [
+				[
+					'operation'                  => 'API_INTEGRATION',
+					'api_integration_preference' => [
+						'rest_api_integration' => [
+							'integration_method'  => 'PAYPAL',
+							'integration_type'    => 'THIRD_PARTY',
+							'third_party_details' => [
+								'features' => ['PAYMENT', 'REFUND'],
+							],
+						],
+					],
+				],
+			],
+			'products'                => [$checkout_type],
+			'legal_consents'          => [
+				[
+					'type'    => 'SHARE_DATA_CONSENT',
+					'granted' => true,
+				],
+			],
+			'partner_config_override' => [
+				'return_url' => $return_url,
+			],
+		]);
+	}
+
+
+	/**
+	 * Get the return URL.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getReturnUrl(EE_Payment_Method $paypal_pm): string
+	{
+		$wp_nonce = EED_Module::getRequest()->getRequestParam('wp_nonce');
+		$nonce    = wp_create_nonce(Domain::NONCE_NAME_ONBOARDING_RETURN);
+		return add_query_arg(
+			[
+				'page'                        => 'espresso_payment_settings',
+				'webhook_action'              => 'eea_pp_commerce_merchant_onboard',
+				'payment_method'              => $paypal_pm->slug(),
+				'_wpnonce'                    => $wp_nonce,
+				'nonce'                       => $nonce,
+				Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
+			],
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Redirect to the payment method (PP) settings home page.
+	 *
+	 * @return void
+	 */
+	public static function redirectToPmSettingsHome(): void
+	{
+		$get_params = EED_Module::getRequest()->getParams();
+		if (empty($get_params['payment_method'])) {
+			// Simply do not redirect.
+			return;
+		}
+		$args_to_add = [
+			'page'           => 'espresso_payment_settings',
+			'payment_method' => $get_params['payment_method'],
+		];
+		if (isset($get_params['sandbox_mode'])) {
+			$args_to_add[ Domain::META_KEY_SANDBOX_MODE ] = $get_params['sandbox_mode'];
+		}
+		$home_url = add_query_arg($args_to_add, admin_url('admin.php'));
+		wp_redirect($home_url);
+		exit;
+	}
+
+
+	/**
+	 * Check user’s onboarding status.
+	 * This will handle the user return from the auth page and also check the status via the API.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function updateOnboardingStatus(): void
+	{
+		// Check if this is the webhook from PayPal.
+		if (! isset($_GET['webhook_action'], $_GET['nonce'])
+			|| $_GET['webhook_action'] !== 'eea_pp_commerce_merchant_onboard'
+		) {
+			return;  // Ignore.
+		}
+		$get_params = EED_Module::getRequest()->getParams();
+		// Get the payment method.
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		// Check the response (GET) parameters.
+		if (! EED_PayPalOnboard::onboardingStatusResponseValid($get_params, $paypal_pm)) {
+			// Missing parameters. Can't proceed.
+			PayPalLogger::errorLog(
+				esc_html__('Missing required onboarding parameters.', 'event_espresso'),
+				$get_params,
+				$paypal_pm
+			);
+			EED_PayPalOnboard::redirectToPmSettingsHome();
+			return;
+		}
+		// Were the requested permissions granted ?
+		if (empty($get_params[ Domain::API_PARAM_PERMISSIONS_GRANTED ])) {
+			$error_message = esc_html__(
+				'Permissions not granted by merchant or email not confirmed.',
+				'event_espresso'
+			);
+			PayPalLogger::errorLog($error_message, $get_params, $paypal_pm);
+			EED_PayPalOnboard::redirectToPmSettingsHome();
+			return;
+		}
+		// Check on the onboarding status (recommended by PP).
+		$onboarding_status = EED_PayPalOnboard::trackSellerOnboarding(
+			$paypal_pm,
+			$get_params[ Domain::META_KEY_SELLER_MERCHANT_ID ]
+		);
+		if (! isset($onboarding_status['valid']) || ! $onboarding_status['valid']) {
+			PayPalLogger::errorLog(
+				$onboarding_status['message'],
+				array_merge($get_params, $onboarding_status),
+				$paypal_pm
+			);
+			EED_PayPalOnboard::redirectToPmSettingsHome();
+			return;
+		}
+		// Start saving the setup and info.
+		PayPalExtraMetaManager::parseAndSaveOptions($paypal_pm, $onboarding_status);
+		// Save the credentials.
+		PayPalExtraMetaManager::saveSellerApiCredentials($paypal_pm, $get_params);
+		// If onboarded successfully, remove the onboarding URL.
+		PayPalExtraMetaManager::deletePmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL);
+		// Also clen GET params by redirecting, because PP auto redirects to the return_url on closing the onboarding window.
+		EED_PayPalOnboard::redirectToPmSettingsHome();
+	}
+
+
+	/**
+	 * Check if all required parameters for the onboarding status check are present.
+	 *
+	 * @param array $data
+	 * @param mixed $paypal_pm
+	 * @return bool
+	 */
+	public static function onboardingStatusResponseValid(array $data, $paypal_pm): bool
+	{
+		// Check that we have all the required parameters and the nonce is ok.
+		if ($paypal_pm instanceof EE_Payment_Method
+			&& wp_verify_nonce($data['nonce'], Domain::NONCE_NAME_ONBOARDING_RETURN)
+			&& ! empty($data[ Domain::API_PARAM_PARTNER_ID ])
+			&& ! empty($data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
+			&& isset($data[ Domain::API_PARAM_PERMISSIONS_GRANTED ])
+			&& isset($data[ Domain::API_PARAM_EMAIL_CONFIRMED ])
+		) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Get partner access token.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getPartnerAccessToken(EE_Payment_Method $paypal_pm): string
+	{
+		// Do we have it saved ?
+		$access_token = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ACCESS_TOKEN);
+		$expired      = EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm);
+		// If we don't have it, request/update it.
+		if (! $access_token || $expired) {
+			return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
+		}
+		// Access token is saved as encrypted, so return decrypted.
+		return $access_token;
+	}
+
+
+	/**
+	 * Get partner access token.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 */
+	public static function partnerAccessTokenExpired(EE_Payment_Method $paypal_pm): bool
+	{
+		$expires_at = (int) PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_EXPIRES_IN);
+		if (! $expires_at) {
+			return true;
+		}
+		// Validate the token expiration date.
+		$now          = time();
+		$minutes_left = round(($expires_at - $now) / 60);
+		// Count as expired if less than 60 minutes till expiration left.
+		if ($minutes_left <= 60) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Request the partner access token from PayPal and save/update it.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function requestPartnerAccessToken(EE_Payment_Method $paypal_pm): string
+	{
+		$nonce = wp_create_nonce('eea_pp_commerce_get_access_token');
+		// Request the access token.
+		$post_args = [
+			'method' => 'POST',
+			'body'   => [
+				'nonce'                       => $nonce,
+				'api_version'                 => 'v1',
+				Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
+			],
+		];
+		if (defined('LOCAL_MIDDLEMAN_SERVER')) {
+			$post_args['sslverify'] = false;
+		}
+		$post_url = EED_PayPalOnboard::getMiddlemanBaseUrl($paypal_pm) . 'get_token';
+		$response = EED_PayPalOnboard::sendRequest($paypal_pm, $post_url, $post_args);
+		if (isset($response['error'])) {
+			return '';
+		}
+		// Check the data we received.
+		if (! EED_PayPalOnboard::partnerTokenResponseValid($response, $paypal_pm)) {
+			return '';
+		}
+		// If we are here all seems to be ok. Save the token and it's data.
+		$saved = PayPalExtraMetaManager::savePartnerAccessToken($paypal_pm, $response);
+		if (! $saved) {
+			return '';
+		}
+		return $response['access_token'];
+	}
+
+
+	/**
+	 * Request seller onboarding status from PayPal.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $merchant_id
+	 * @return array
+	 */
+	public static function trackSellerOnboarding(EE_Payment_Method $paypal_pm, string $merchant_id): array
+	{
+		$track_onboarding = EED_PayPalOnboard::getTrackOnboardingApi($paypal_pm, $merchant_id);
+		if (! $track_onboarding instanceof TrackSellerOnboarding) {
+			$err_msg = esc_html__('Failed to track seller onboarding.', 'event_espresso');
+			return ['error' => 'TRACK_ONBOARDING_FAILED', 'message' => $err_msg];
+		}
+		return $track_onboarding->isValid();
+	}
+
+
+	/**
+	 * Returns the Track Seller Onboarding API.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $merchant_id
+	 * @return TrackSellerOnboarding|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getTrackOnboardingApi(
+		EE_Payment_Method $paypal_pm,
+		string            $merchant_id
+	): ?TrackSellerOnboarding {
+		$partner_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_MERCHANT_ID);
+		$paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
+		if (! $paypal_api instanceof PayPalApi || ! $partner_id) {
+			return null;
+		}
+		return new TrackSellerOnboarding($paypal_api, $partner_id, $merchant_id, $paypal_pm->debug_mode());
+	}
+
+
+	/**
+	 * Check the onboard status and return the result.
+	 * (AJAX)
+	 *
+	 * @return void
+	 */
+	public static function getOnboardStatus(): void
+	{
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		if (! $paypal_pm instanceof EE_Payment_Method) {
+			$err_msg = esc_html__('Could not specify the payment method.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, EED_Module::getRequest()->postParams(), $paypal_pm);
+			wp_send_json(['on_board' => false]);
+		}
+		try {
+			$seller_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_SELLER_MERCHANT_ID) ?? '--';
+		} catch (Exception $e) {
+			$seller_id = '--';
+		}
+		wp_send_json(
+			[
+				'on_board'  => EED_PayPalOnboard::isOnboard($paypal_pm),
+				'seller_id' => $seller_id,
+			]
+		);
+	}
+
+
+	/**
+	 * De-authorize the seller. Remove all API credentials.
+	 * (AJAX)
+	 *
+	 * @return void
+	 */
+	public static function offboard(): void
+	{
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		if (! $paypal_pm instanceof EE_Payment_Method) {
+			wp_send_json([
+				'error'   => 'INVALID_PM',
+				'message' => esc_html__(
+					'Invalid payment method. Please refresh the page and try again.',
+					'event_espresso'
+				),
+			]);
+		}
+		PayPalExtraMetaManager::deleteAllData($paypal_pm);
+		wp_send_json(['success' => true]);
+	}
+
+
+	/**
+	 * Checks if already onboard.
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return boolean
+	 */
+	public static function isOnboard(EE_Payment_Method $payment_method): bool
+	{
+		$pp_meta_data = PayPalExtraMetaManager::getAllData($payment_method);
+		return
+			// onborded with a third party integration ?
+			(! empty($pp_meta_data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
+				&& ! empty($pp_meta_data[ Domain::META_KEY_ACCESS_TOKEN ])
+			)
+			// or with the first party integration ?
+			|| (! empty($pp_meta_data[ Domain::META_KEY_CLIENT_ID ])
+				&& ! empty($pp_meta_data[ Domain::META_KEY_CLIENT_SECRET ])
+				&& ! empty($pp_meta_data[ Domain::META_KEY_PAYER_ID ])
+			);
+	}
+
+
+	/**
+	 * Send a request and return a decoded response body.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $request_url
+	 * @param array             $request_args
+	 * @return array
+	 */
+	public static function sendRequest(EE_Payment_Method $paypal_pm, string $request_url, array $request_args): array
+	{
+		$error_return = ['error' => true];
+		$response     = wp_remote_request($request_url, $request_args);
+		if (is_wp_error($response)) {
+			$message = $response->get_error_message();
+			PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
+			$error_return['message'] = $message;
+			return $error_return;
+		}
+		$response_body = (isset($response['body']) && $response['body']) ? json_decode($response['body'], true) : [];
+		if (empty($response_body) || isset($response_body['error'])) {
+			$message = $response_body['error_description']
+					   ?? sprintf(
+						   esc_html__('Unknown response received while sending a request to: %1$s', 'event_espresso'),
+						   $request_url
+					   );
+			PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
+			$error_return['message'] = $message;
+			return $error_return;
+		}
+		return $response_body;
+	}
+
+
+	/**
+	 * Check the response for a partner token request.
+	 *
+	 * @param                   $response
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 */
+	public static function partnerTokenResponseValid($response, EE_Payment_Method $paypal_pm): bool
+	{
+		// Check the data we received.
+		if (
+			empty($response['nonce'])
+			|| ! wp_verify_nonce($response['nonce'], 'eea_pp_commerce_get_access_token')
+			|| empty($response['access_token'])
+			|| empty($response['app_id'])
+			|| empty($response['expires_in'])
+			|| empty($response['partner_client_id'])
+			|| empty($response['partner_merchant_id'])
+		) {
+			// This is an error.
+			$err_msg = esc_html__('Incoming parameter validation failed.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, (array) $response, $paypal_pm);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * Returns the base URL to the middleman server.
+	 * If LOCAL_MIDDLEMAN_SERVER is defined, requests will be sent to connect.eventespresso.test
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getMiddlemanBaseUrl(EE_Payment_Method $payment_method): string
+	{
+		$target = defined('LOCAL_MIDDLEMAN_SERVER') ? 'test' : 'com';
+		// If this PM is used under different provider accounts, you might need an account indicator.
+		$account = defined('EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR') ? EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR : '';
+		$postfix = $payment_method->debug_mode() ? '_sandbox' : '';
+		$path    = 'paypal_commerce' . $account . $postfix;
+		return 'https://connect.eventespresso.' . $target . '/' . $path . '/';
+	}
+
+
+	/**
+	 * This Payment Method admin notices.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function adminNotice()
+	{
+		// A notice to re-connect if still connected through the first party integration.
+		$pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
+		// Show the notice only if PayPal Commerce is active.
+		if (! $pp_commerce instanceof EE_Payment_Method
+			|| ! EED_PayPalOnboard::isOnboard($pp_commerce)
+			|| EED_PayPalCommerce::isThirdParty($pp_commerce)
+		) {
+			return;
+		}
+		add_action('admin_notices', [__CLASS__, 'reConnectNotice']);
+	}
+
+
+	/**
+	 * Re-connect notice contents.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function reConnectNotice()
+	{
+		$open_anchor = $close_anchor = '';
+		$pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
+		if ($pp_commerce instanceof EE_Payment_Method) {
+			$pm_page = add_query_arg(
+				[
+					'page'           => 'espresso_payment_settings',
+					'webhook_action' => 'eea_pp_commerce_merchant_onboard',
+					'payment_method' => $pp_commerce->slug(),
+				],
+				admin_url('admin.php')
+			);
+			$open_anchor  = "<a href='$pm_page'>";
+			$close_anchor = "</a>";
+		}
+		echo '<div class="error"><p>'
+		. sprintf(
+			esc_html__(
+				'%1$sPayPal Commerce%2$s has updated the API integration type to allow more flexibility with payments. Please disconnect and re-Connect on the %3$sPayment Methods admin%4$s page to update the credentials and allow advanced payment type options.',
+				'event_espresso'
+			),
+			'<strong>',
+			'</strong>',
+			$open_anchor,
+			$close_anchor
+		 )
+		 . '</p></div>';
+	}
 }

PaymentMethods/PayPalCommerce/tools/extra_meta/PayPalExtraMetaManager.php

Indentation +267 added lines, -267 removed lines

@@ -22,295 +22,295 @@
  */
 class PayPalExtraMetaManager
 {
-    /**
-     * Get payment method option/extra meta
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $option_name
-     * @return mixed
-     */
-    public static function getPmOption(EE_Payment_Method $paypal_pm, string $option_name)
-    {
-        $pp_meta_data = self::extraMeta($paypal_pm);
-        $option_value = $pp_meta_data->getOption($option_name);
-        // Decrypt the encrypted options.
-        if (
-            $option_name === Domain::META_KEY_ACCESS_TOKEN
-            || $option_name === Domain::META_KEY_PARTNER_MERCHANT_ID
-            || $option_name === Domain::META_KEY_CLIENT_SECRET
-        ) {
-            $option_value = self::decryptString($option_value, $paypal_pm);
-        }
-        return $option_value;
-    }
+	/**
+	 * Get payment method option/extra meta
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $option_name
+	 * @return mixed
+	 */
+	public static function getPmOption(EE_Payment_Method $paypal_pm, string $option_name)
+	{
+		$pp_meta_data = self::extraMeta($paypal_pm);
+		$option_value = $pp_meta_data->getOption($option_name);
+		// Decrypt the encrypted options.
+		if (
+			$option_name === Domain::META_KEY_ACCESS_TOKEN
+			|| $option_name === Domain::META_KEY_PARTNER_MERCHANT_ID
+			|| $option_name === Domain::META_KEY_CLIENT_SECRET
+		) {
+			$option_value = self::decryptString($option_value, $paypal_pm);
+		}
+		return $option_value;
+	}
 
 
-    /**
-     * Save payment method option/extra meta
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $option_name
-     * @param                   $option_value
-     * @return bool
-     */
-    public static function savePmOption(EE_Payment_Method $paypal_pm, string $option_name, $option_value): bool
-    {
-        $pp_meta_data = self::extraMeta($paypal_pm);
-        return $pp_meta_data->saveOption($option_name, $option_value);
-    }
+	/**
+	 * Save payment method option/extra meta
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $option_name
+	 * @param                   $option_value
+	 * @return bool
+	 */
+	public static function savePmOption(EE_Payment_Method $paypal_pm, string $option_name, $option_value): bool
+	{
+		$pp_meta_data = self::extraMeta($paypal_pm);
+		return $pp_meta_data->saveOption($option_name, $option_value);
+	}
 
 
-    /**
-     * Save a list of payment method options/extra meta.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $options_list
-     * @return bool
-     */
-    public static function savePmOptions(EE_Payment_Method $paypal_pm, array $options_list): bool
-    {
-        $pp_meta_data = self::extraMeta($paypal_pm);
-        return $pp_meta_data->saveBatch($options_list);
-    }
+	/**
+	 * Save a list of payment method options/extra meta.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $options_list
+	 * @return bool
+	 */
+	public static function savePmOptions(EE_Payment_Method $paypal_pm, array $options_list): bool
+	{
+		$pp_meta_data = self::extraMeta($paypal_pm);
+		return $pp_meta_data->saveBatch($options_list);
+	}
 
 
-    /**
-     * Delete payment method option/extra meta
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $option_name
-     * @return bool
-     */
-    public static function deletePmOption(EE_Payment_Method $paypal_pm, string $option_name): bool
-    {
-        $pp_meta_data = self::extraMeta($paypal_pm);
-        return $pp_meta_data->deleteOption($option_name);
-    }
+	/**
+	 * Delete payment method option/extra meta
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $option_name
+	 * @return bool
+	 */
+	public static function deletePmOption(EE_Payment_Method $paypal_pm, string $option_name): bool
+	{
+		$pp_meta_data = self::extraMeta($paypal_pm);
+		return $pp_meta_data->deleteOption($option_name);
+	}
 
 
-    /**
-     * Get all options for payment method.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return array|bool
-     */
-    public static function getAllData(EE_Payment_Method $paypal_pm)
-    {
-        $pp_meta_data = self::extraMeta($paypal_pm);
-        return $pp_meta_data->getMetaData();
-    }
+	/**
+	 * Get all options for payment method.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return array|bool
+	 */
+	public static function getAllData(EE_Payment_Method $paypal_pm)
+	{
+		$pp_meta_data = self::extraMeta($paypal_pm);
+		return $pp_meta_data->getMetaData();
+	}
 
 
-    /**
-     * Delete all options for this payment method.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     */
-    public static function deleteAllData(EE_Payment_Method $paypal_pm): bool
-    {
-        $pp_meta_data = self::extraMeta($paypal_pm);
-        return $pp_meta_data->deleteMetaData();
-    }
+	/**
+	 * Delete all options for this payment method.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 */
+	public static function deleteAllData(EE_Payment_Method $paypal_pm): bool
+	{
+		$pp_meta_data = self::extraMeta($paypal_pm);
+		return $pp_meta_data->deleteMetaData();
+	}
 
 
-    /**
-     * Save the debug mode option if it changed.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $request_data
-     * @return bool             Updated or not.
-     */
-    public static function updateDebugMode(EE_Payment_Method $paypal_pm, array $request_data): bool
-    {
-        if (
-            isset($request_data['sandbox_mode'])
-            && in_array($request_data['sandbox_mode'], ['0', '1'], true)
-            && $paypal_pm->debug_mode() !== (bool) $request_data['sandbox_mode']
-        ) {
-            try {
-                $paypal_pm->save(['PMD_debug_mode' => $request_data['sandbox_mode']]);
-            } catch (EE_Error $e) {
-                $err_msg = sprintf(
-                    esc_html__('Note, debug mode not saved ! %1$s', 'event_espresso'),
-                    $e->getMessage()
-                );
-                PayPalLogger::errorLog($err_msg, $request_data, $paypal_pm);
-                return false;
-            }
-             return true;
-        }
-        return false;
-    }
+	/**
+	 * Save the debug mode option if it changed.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $request_data
+	 * @return bool             Updated or not.
+	 */
+	public static function updateDebugMode(EE_Payment_Method $paypal_pm, array $request_data): bool
+	{
+		if (
+			isset($request_data['sandbox_mode'])
+			&& in_array($request_data['sandbox_mode'], ['0', '1'], true)
+			&& $paypal_pm->debug_mode() !== (bool) $request_data['sandbox_mode']
+		) {
+			try {
+				$paypal_pm->save(['PMD_debug_mode' => $request_data['sandbox_mode']]);
+			} catch (EE_Error $e) {
+				$err_msg = sprintf(
+					esc_html__('Note, debug mode not saved ! %1$s', 'event_espresso'),
+					$e->getMessage()
+				);
+				PayPalLogger::errorLog($err_msg, $request_data, $paypal_pm);
+				return false;
+			}
+			 return true;
+		}
+		return false;
+	}
 
 
-    /**
-     * Save partner access token and parameters.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $response
-     * @return bool
-     */
-    public static function savePartnerAccessToken(EE_Payment_Method $paypal_pm, array $response): bool
-    {
-        $paypal_data         = [];
-        $expected_parameters = [
-            Domain::META_KEY_ACCESS_TOKEN,
-            Domain::META_KEY_EXPIRES_IN,
-            Domain::META_KEY_APP_ID,
-            Domain::META_KEY_PARTNER_CLIENT_ID,
-            Domain::META_KEY_PARTNER_MERCHANT_ID,
-            Domain::META_KEY_BN_CODE,
-        ];
-        foreach ($expected_parameters as $api_key) {
-            if (! isset($response[ $api_key ])) {
-                // Don't want to try saving data that doesn't exist.
-                continue;
-            }
-            try {
-                switch ($api_key) {
-                    case Domain::META_KEY_ACCESS_TOKEN:
-                    case Domain::META_KEY_PARTNER_MERCHANT_ID:
-                        $paypal_data[ $api_key ] = self::encryptString($response[ $api_key ], $paypal_pm);
-                        break;
-                    case Domain::META_KEY_EXPIRES_IN:
-                        $paypal_data[ $api_key ] = time() + (int) sanitize_key($response[ $api_key ]);
-                        break;
-                    default:
-                        $paypal_data[ $api_key ] = sanitize_text_field($response[ $api_key ]);
-                }
-            } catch (Exception $exception) {
-                PayPalLogger::errorLog($exception->getMessage(), $response, $paypal_pm);
-                return false;
-            }
-        }
-        return self::savePmOptions($paypal_pm, $paypal_data);
-    }
+	/**
+	 * Save partner access token and parameters.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $response
+	 * @return bool
+	 */
+	public static function savePartnerAccessToken(EE_Payment_Method $paypal_pm, array $response): bool
+	{
+		$paypal_data         = [];
+		$expected_parameters = [
+			Domain::META_KEY_ACCESS_TOKEN,
+			Domain::META_KEY_EXPIRES_IN,
+			Domain::META_KEY_APP_ID,
+			Domain::META_KEY_PARTNER_CLIENT_ID,
+			Domain::META_KEY_PARTNER_MERCHANT_ID,
+			Domain::META_KEY_BN_CODE,
+		];
+		foreach ($expected_parameters as $api_key) {
+			if (! isset($response[ $api_key ])) {
+				// Don't want to try saving data that doesn't exist.
+				continue;
+			}
+			try {
+				switch ($api_key) {
+					case Domain::META_KEY_ACCESS_TOKEN:
+					case Domain::META_KEY_PARTNER_MERCHANT_ID:
+						$paypal_data[ $api_key ] = self::encryptString($response[ $api_key ], $paypal_pm);
+						break;
+					case Domain::META_KEY_EXPIRES_IN:
+						$paypal_data[ $api_key ] = time() + (int) sanitize_key($response[ $api_key ]);
+						break;
+					default:
+						$paypal_data[ $api_key ] = sanitize_text_field($response[ $api_key ]);
+				}
+			} catch (Exception $exception) {
+				PayPalLogger::errorLog($exception->getMessage(), $response, $paypal_pm);
+				return false;
+			}
+		}
+		return self::savePmOptions($paypal_pm, $paypal_data);
+	}
 
 
-    /**
-     * Save merchant/seller API credentials.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $response
-     * @return bool
-     */
-    public static function saveSellerApiCredentials(EE_Payment_Method $paypal_pm, array $response): bool
-    {
-        $api_credentials     = [];
-        $expected_parameters = [
-            Domain::META_KEY_SELLER_MERCHANT_ID,
-        ];
-        foreach ($expected_parameters as $api_key) {
-            if (! isset($response[ $api_key ])) {
-                // Don't want to try saving data that doesn't exist.
-                continue;
-            }
-            try {
-                $api_credentials[ $api_key ] = $response[ $api_key ];
-            } catch (Exception $exception) {
-                PayPalLogger::errorLog($exception->getMessage(), $response, $paypal_pm);
-                return false;
-            }
-        }
-        return self::savePmOptions($paypal_pm, $api_credentials);
-    }
+	/**
+	 * Save merchant/seller API credentials.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $response
+	 * @return bool
+	 */
+	public static function saveSellerApiCredentials(EE_Payment_Method $paypal_pm, array $response): bool
+	{
+		$api_credentials     = [];
+		$expected_parameters = [
+			Domain::META_KEY_SELLER_MERCHANT_ID,
+		];
+		foreach ($expected_parameters as $api_key) {
+			if (! isset($response[ $api_key ])) {
+				// Don't want to try saving data that doesn't exist.
+				continue;
+			}
+			try {
+				$api_credentials[ $api_key ] = $response[ $api_key ];
+			} catch (Exception $exception) {
+				PayPalLogger::errorLog($exception->getMessage(), $response, $paypal_pm);
+				return false;
+			}
+		}
+		return self::savePmOptions($paypal_pm, $api_credentials);
+	}
 
 
-    /**
-     * Save other payment method related settings from a data array.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param array             $data
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function parseAndSaveOptions(EE_Payment_Method $paypal_pm, array $data): bool
-    {
-        $allowed_checkout_type = 'express_checkout';
-        // Note, although PayPal shows that this should include PPCP_CUSTOM or EXPRESS_CHECKOUT only,
-        // in reality, it will also include other products like MOBILE_PAYMENT_ACCEPTANCE etc.
-        if (! empty($data['response']['products'][0]['name']) && is_array($data['response']['products'])) {
-            foreach ($data['response']['products'] as $product) {
-                if (str_contains($product['name'], 'PPCP')) {
-                    // This merchant has PPCP in the products list, so we can enable both (all) checkout types.
-                    $allowed_checkout_type = 'all';
-                    break;
-                }
-            }
-        }
-        // Set the Checkout type (a PM option), just in case merchant doesn't save PM options manually.
-        $checkout_type = $paypal_pm->get_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, true, false);
-        if (! $checkout_type) {
-            $paypal_pm->update_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, $allowed_checkout_type);
-        }
-        return PayPalExtraMetaManager::savePmOption(
-            $paypal_pm,
-            Domain::META_KEY_ALLOWED_CHECKOUT_TYPE,
-            $allowed_checkout_type
-        );
-    }
+	/**
+	 * Save other payment method related settings from a data array.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param array             $data
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function parseAndSaveOptions(EE_Payment_Method $paypal_pm, array $data): bool
+	{
+		$allowed_checkout_type = 'express_checkout';
+		// Note, although PayPal shows that this should include PPCP_CUSTOM or EXPRESS_CHECKOUT only,
+		// in reality, it will also include other products like MOBILE_PAYMENT_ACCEPTANCE etc.
+		if (! empty($data['response']['products'][0]['name']) && is_array($data['response']['products'])) {
+			foreach ($data['response']['products'] as $product) {
+				if (str_contains($product['name'], 'PPCP')) {
+					// This merchant has PPCP in the products list, so we can enable both (all) checkout types.
+					$allowed_checkout_type = 'all';
+					break;
+				}
+			}
+		}
+		// Set the Checkout type (a PM option), just in case merchant doesn't save PM options manually.
+		$checkout_type = $paypal_pm->get_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, true, false);
+		if (! $checkout_type) {
+			$paypal_pm->update_extra_meta(Domain::META_KEY_CHECKOUT_TYPE, $allowed_checkout_type);
+		}
+		return PayPalExtraMetaManager::savePmOption(
+			$paypal_pm,
+			Domain::META_KEY_ALLOWED_CHECKOUT_TYPE,
+			$allowed_checkout_type
+		);
+	}
 
 
-    /**
-     * Get PayPal extra meta helper.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return PayPalExtraMeta
-     */
-    public static function extraMeta(EE_Payment_Method $paypal_pm): PayPalExtraMeta
-    {
-        return LoaderFactory::getLoader()->getShared(PayPalExtraMeta::class, [$paypal_pm]);
-    }
+	/**
+	 * Get PayPal extra meta helper.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return PayPalExtraMeta
+	 */
+	public static function extraMeta(EE_Payment_Method $paypal_pm): PayPalExtraMeta
+	{
+		return LoaderFactory::getLoader()->getShared(PayPalExtraMeta::class, [$paypal_pm]);
+	}
 
 
-    /**
-     * Encrypt a text field.
-     *
-     * @param string            $text
-     * @param EE_Payment_Method $paypal_pm
-     * @return string|null
-     */
-    public static function encryptString(string $text, EE_Payment_Method $paypal_pm): ?string
-    {
-        // We sure we are getting something ?
-        if (! $text) {
-            return $text;
-        }
-        // Do encrypt.
-        $encryptor      = LoaderFactory::getLoader()->getShared(OpenSSLEncryption::class, [new Base64Encoder()]);
-        $sanitized_text = sanitize_text_field($text);
-        $key_identifier = $paypal_pm->debug_mode()
-            ? PPCommerceEncryptionKeyManager::SANDBOX_ENCRYPTION_KEY_ID
-            : PPCommerceEncryptionKeyManager::PRODUCTION_ENCRYPTION_KEY_ID;
-        return $encryptor->encrypt($sanitized_text, $key_identifier);
-    }
+	/**
+	 * Encrypt a text field.
+	 *
+	 * @param string            $text
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string|null
+	 */
+	public static function encryptString(string $text, EE_Payment_Method $paypal_pm): ?string
+	{
+		// We sure we are getting something ?
+		if (! $text) {
+			return $text;
+		}
+		// Do encrypt.
+		$encryptor      = LoaderFactory::getLoader()->getShared(OpenSSLEncryption::class, [new Base64Encoder()]);
+		$sanitized_text = sanitize_text_field($text);
+		$key_identifier = $paypal_pm->debug_mode()
+			? PPCommerceEncryptionKeyManager::SANDBOX_ENCRYPTION_KEY_ID
+			: PPCommerceEncryptionKeyManager::PRODUCTION_ENCRYPTION_KEY_ID;
+		return $encryptor->encrypt($sanitized_text, $key_identifier);
+	}
 
 
-    /**
-     * Decrypt a string.
-     *
-     * @param string            $text
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     */
-    public static function decryptString(string $text, EE_Payment_Method $paypal_pm): string
-    {
-        // Are we even getting something ?
-        if (! $text) {
-            return $text;
-        }
-        // Try decrypting.
-        try {
-            $encryptor      = LoaderFactory::getLoader()->getShared(OpenSSLEncryption::class, [new Base64Encoder()]);
-            $key_identifier = $paypal_pm->debug_mode()
-                ? PPCommerceEncryptionKeyManager::SANDBOX_ENCRYPTION_KEY_ID
-                : PPCommerceEncryptionKeyManager::PRODUCTION_ENCRYPTION_KEY_ID;
-            $decrypted      = $encryptor->decrypt($text, $key_identifier);
-        } catch (Exception $e) {
-            return $text;
-        }
-        return $decrypted ?? $text;
-    }
+	/**
+	 * Decrypt a string.
+	 *
+	 * @param string            $text
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 */
+	public static function decryptString(string $text, EE_Payment_Method $paypal_pm): string
+	{
+		// Are we even getting something ?
+		if (! $text) {
+			return $text;
+		}
+		// Try decrypting.
+		try {
+			$encryptor      = LoaderFactory::getLoader()->getShared(OpenSSLEncryption::class, [new Base64Encoder()]);
+			$key_identifier = $paypal_pm->debug_mode()
+				? PPCommerceEncryptionKeyManager::SANDBOX_ENCRYPTION_KEY_ID
+				: PPCommerceEncryptionKeyManager::PRODUCTION_ENCRYPTION_KEY_ID;
+			$decrypted      = $encryptor->decrypt($text, $key_identifier);
+		} catch (Exception $e) {
+			return $text;
+		}
+		return $decrypted ?? $text;
+	}
 }

espresso.php

Indentation +107 added lines, -107 removed lines

@@ -37,138 +37,138 @@
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time.
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time.
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
 <div class="error">
 	<p>
 		<?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
 	</p>
 </div>
 <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '7.4.0');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '7.4.0');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
 <div class="error">
 	<p>
 		<?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="https://www.php.net/downloads.php">https://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="https://www.php.net/downloads.php">https://php.net/downloads.php</a>'
+					);
+					?>
 	</p>
 </div>
 <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
 
-        require_once __DIR__ . '/vendor/autoload.php';
+		require_once __DIR__ . '/vendor/autoload.php';
 
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version(): string
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '5.0.14.rc.006');
-        }
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version(): string
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '5.0.14.rc.006');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-            update_option('event-espresso-core_allow_tracking', 'no');
-            update_option('event-espresso-core_tracking_notice', 'hide');
-            // Run WP GraphQL activation callback
-            espressoLoadWpGraphQL();
-            graphql_activation_callback();
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+			update_option('event-espresso-core_allow_tracking', 'no');
+			update_option('event-espresso-core_tracking_notice', 'hide');
+			// Run WP GraphQL activation callback
+			espressoLoadWpGraphQL();
+			graphql_activation_callback();
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        /**
-         * espresso_plugin_deactivation
-         */
-        function espresso_plugin_deactivation()
-        {
-            // Run WP GraphQL deactivation callback
-            espressoLoadWpGraphQL();
-            graphql_deactivation_callback();
-            delete_option('event-espresso-core_allow_tracking');
-            delete_option('event-espresso-core_tracking_notice');
-        }
-        register_deactivation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_deactivation');
+		/**
+		 * espresso_plugin_deactivation
+		 */
+		function espresso_plugin_deactivation()
+		{
+			// Run WP GraphQL deactivation callback
+			espressoLoadWpGraphQL();
+			graphql_deactivation_callback();
+			delete_option('event-espresso-core_allow_tracking');
+			delete_option('event-espresso-core_tracking_notice');
+		}
+		register_deactivation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_deactivation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin(string $plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin(string $plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }
 
 
 if (! function_exists('espressoLoadWpGraphQL')) {
-    function espressoLoadWpGraphQL()
-    {
-        if (
-            ! class_exists('WPGraphQL')
-            && is_readable(__DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php')
-        ) {
-            require_once __DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php';
-        }
-    }
+	function espressoLoadWpGraphQL()
+	{
+		if (
+			! class_exists('WPGraphQL')
+			&& is_readable(__DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php')
+		) {
+			require_once __DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php';
+		}
+	}
 }

core/EE_Capabilities.core.php

Indentation +1340 added lines, -1340 removed lines

@@ -15,967 +15,967 @@ 
 final class EE_Capabilities extends EE_Base
 {
 
-    const ROLE_ADMINISTRATOR = 'administrator';
-
-    const ROLE_EVENTS_ADMINISTRATOR = 'ee_events_administrator';
-
-
-    /**
-     * the name of the wp option used to store caps previously initialized
-     */
-    const option_name = 'ee_caps_initialized';
-
-    private static ?EE_Capabilities $_instance = null;
-
-
-    /**
-     * This is a map of caps that correspond to a default WP_Role.
-     * Array is indexed by Role and values are ee capabilities.
-     *
-     * @since 4.5.0
-     * @var array
-     */
-    private array $capabilities_map = [];
-
-    /**
-     * This used to hold an array of EE_Meta_Capability_Map objects
-     * that define the granular capabilities mapped to for a user depending on context.
-     *
-     * @var EE_Meta_Capability_Map[]
-     */
-    private array $_meta_caps = [];
-
-    /**
-     * The internal $capabilities_map needs to be initialized before it can be used.
-     * This flag tracks whether that has happened or not.
-     * But for this to work, we need three states to indicate:
-     *      initialization has not occurred at all
-     *      initialization has started but is not complete
-     *      initialization is complete
-     * The reason this is needed is because the addCaps() method
-     * normally requires the $capabilities_map to be initialized,
-     * but is also used during the initialization process.
-     * So:
-     *      If initialized === null, init_caps() will be called before any other methods will run.
-     *      If initialized === false, then init_caps() is in the process of running it's logic.
-     *      If initialized === true, then init_caps() has completed the initialization process.
-     *
-     * @var boolean|null $initialized
-     */
-    private ?bool $initialized = null;
-
-    /**
-     * @var boolean $reset
-     */
-    private bool $reset = false;
-
-
-    /**
-     * singleton method used to instantiate class object
-     *
-     * @return EE_Capabilities
-     * @since 4.5.0
-     */
-    public static function instance(): EE_Capabilities
-    {
-        // check if instantiated, and if not do so.
-        if (! self::$_instance instanceof EE_Capabilities) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * private constructor
-     *
-     * @since 4.5.0
-     */
-    private function __construct()
-    {
-    }
-
-
-    /**
-     * This delays the initialization of the capabilities class until EE_System core is loaded and ready.
-     *
-     * @param bool $reset allows for resetting the default capabilities saved on roles.  Note that this doesn't
-     *                    actually REMOVE any capabilities from existing roles, it just resaves defaults roles and
-     *                    ensures that they are up to date.
-     * @since 4.5.0
-     * @return bool
-     * @throws EE_Error
-     */
-    public function init_caps(?bool $reset = false): bool
-    {
-        if (DbStatus::isOffline()) {
-            return false;
-        }
-        $this->reset = filter_var($reset, FILTER_VALIDATE_BOOLEAN);
-        // if reset, then completely delete the cache option and clear the $capabilities_map property.
-        if ($this->reset) {
-            $this->initialized      = null;
-            $this->capabilities_map = [];
-            delete_option(self::option_name);
-        }
-        if ($this->initialized === null) {
-            $this->initialized = false;
-            do_action(
-                'AHEE__EE_Capabilities__init_caps__before_initialization',
-                $this->reset
-            );
-            $this->addCaps($this->_init_caps_map());
-            $this->_set_meta_caps();
-            do_action(
-                'AHEE__EE_Capabilities__init_caps__after_initialization',
-                $this->capabilities_map
-            );
-            $this->initialized = true;
-        }
-        // reset $this->reset so that it's not stuck on true if init_caps() gets called again
-        $this->reset = false;
-        return true;
-    }
-
-
-    /**
-     * This sets the meta caps property.
-     *
-     * @return void
-     * @throws EE_Error
-     * @since 4.5.0
-     */
-    private function _set_meta_caps()
-    {
-        // get default meta caps and filter the returned array
-        $this->_meta_caps = apply_filters(
-            'FHEE__EE_Capabilities___set_meta_caps__meta_caps',
-            $this->_get_default_meta_caps_array()
-        );
-        // add filter for map_meta_caps but only if models can query.
-        if (! has_filter('map_meta_cap', [$this, 'map_meta_caps'])) {
-            add_filter('map_meta_cap', [$this, 'map_meta_caps'], 10, 4);
-        }
-    }
-
-
-    /**
-     * This builds and returns the default meta_caps array only once.
-     *
-     * @return array
-     * @throws EE_Error
-     * @since  4.8.28.rc.012
-     */
-    private function _get_default_meta_caps_array(): array
-    {
-        static $default_meta_caps = [];
-        // make sure we're only ever initializing the default _meta_caps array once if it's empty.
-        if (empty($default_meta_caps)) {
-            $default_meta_caps = [
-                // edits
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_event',
-                    ['Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events']
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_venue',
-                    ['Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues']
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_registration',
-                    ['Registration', '', 'ee_edit_others_registrations', '']
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_checkin',
-                    ['Registration', '', 'ee_edit_others_checkins', '']
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_edit_message',
-                    ['Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages']
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_default_ticket',
-                    ['Ticket', '', 'ee_edit_others_default_tickets', '']
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_edit_question',
-                    ['Question', '', '', 'ee_edit_system_questions']
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_edit_question_group',
-                    ['Question_Group', '', '', 'ee_edit_system_question_groups']
-                ),
-                new EE_Meta_Capability_Map_Edit(
-                    'ee_edit_payment_method',
-                    ['Payment_Method', '', 'ee_edit_others_payment_methods', '']
-                ),
-                // reads
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_event',
-                    ['Event', '', 'ee_read_others_events', 'ee_read_private_events']
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_venue',
-                    ['Venue', '', 'ee_read_others_venues', 'ee_read_private_venues']
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_registration',
-                    ['Registration', '', 'ee_read_others_registrations', '']
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_checkin',
-                    ['Registration', '', 'ee_read_others_checkins', '']
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_read_message',
-                    ['Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages']
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_default_ticket',
-                    ['Ticket', '', 'ee_read_others_default_tickets', '']
-                ),
-                new EE_Meta_Capability_Map_Read(
-                    'ee_read_payment_method',
-                    ['Payment_Method', '', 'ee_read_others_payment_methods', '']
-                ),
-                // deletes
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_event',
-                    [
-                        'Event',
-                        'ee_delete_published_events',
-                        'ee_delete_others_events',
-                        'ee_delete_private_events',
-                    ]
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_venue',
-                    [
-                        'Venue',
-                        'ee_delete_published_venues',
-                        'ee_delete_others_venues',
-                        'ee_delete_private_venues',
-                    ]
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_registration',
-                    ['Registration', '', 'ee_delete_others_registrations', '']
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_checkin',
-                    ['Registration', '', 'ee_delete_others_checkins', '']
-                ),
-                new EE_Meta_Capability_Map_Messages_Cap(
-                    'ee_delete_message',
-                    ['Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages']
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_default_ticket',
-                    ['Ticket', '', 'ee_delete_others_default_tickets', '']
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_delete_question',
-                    ['Question', '', '', 'delete_system_questions']
-                ),
-                new EE_Meta_Capability_Map_Registration_Form_Cap(
-                    'ee_delete_question_group',
-                    ['Question_Group', '', '', 'delete_system_question_groups']
-                ),
-                new EE_Meta_Capability_Map_Delete(
-                    'ee_delete_payment_method',
-                    ['Payment_Method', '', 'ee_delete_others_payment_methods', '']
-                ),
-            ];
-        }
-        return $default_meta_caps;
-    }
-
-
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     * The actual logic is carried out by implementer classes in their definition of _map_meta_caps.
-     *
-     * @param array       $caps    actual users capabilities
-     * @param string|null $cap     initial capability name that is being checked (the "map" key)
-     * @param int         $user_id The user id
-     * @param array       $args    Adds context to the cap. Typically the object ID.
-     * @return array actual users capabilities
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     */
-    public function map_meta_caps(array $caps, ?string $cap, int $user_id, array $args): array
-    {
-        if (! $cap || ! did_action('AHEE__EE_System__load_espresso_addons__complete')) {
-            return $caps;
-        }
-        // loop through our _meta_caps array
-        foreach ($this->_meta_caps as $meta_map) {
-            if (! $meta_map instanceof EE_Meta_Capability_Map) {
-                continue;
-            }
-            // don't load models if there is no object ID in the args
-            if (! empty($args[0])) {
-                $meta_map->ensure_is_model();
-            }
-            $caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
-        }
-        return $caps;
-    }
-
-
-    /**
-     * This sets up and returns the initial capabilities map for Event Espresso
-     * Note this array is filtered.
-     * It is assumed that all available EE capabilities are assigned to the administrator role.
-     *
-     * @return array
-     * @since 4.5.0
-     */
-    private function _init_caps_map(): array
-    {
-        return apply_filters(
-            'FHEE__EE_Capabilities__init_caps_map__caps',
-            [
-                EE_Capabilities::ROLE_ADMINISTRATOR        => [
-                    // basic access
-                    'ee_read_ee',
-                    // gateways
-                    // note that with payment method capabilities, although we've implemented
-                    // capability mapping which will be used for accessing payment methods owned by
-                    // other users.  This is not fully implemented yet in the payment method ui.
-                    // Currently only the "plural" caps are in active use.
-                    // (Specific payment method caps are in use as well).
-                    'ee_manage_gateways',
-                    'ee_read_payment_methods',
-                    'ee_read_others_payment_methods',
-                    'ee_edit_payment_methods',
-                    'ee_edit_others_payment_methods',
-                    'ee_delete_payment_methods',
-                    // events
-                    'ee_publish_events',
-                    'ee_read_private_events',
-                    'ee_read_others_events',
-                    'ee_read_events',
-                    'ee_edit_events',
-                    'ee_edit_published_events',
-                    'ee_edit_others_events',
-                    'ee_edit_private_events',
-                    'ee_delete_published_events',
-                    'ee_delete_private_events',
-                    'ee_delete_events',
-                    'ee_delete_others_events',
-                    // event categories
-                    'ee_manage_event_categories',
-                    'ee_edit_event_category',
-                    'ee_delete_event_category',
-                    'ee_assign_event_category',
-                    // venues
-                    'ee_publish_venues',
-                    'ee_read_venues',
-                    'ee_read_others_venues',
-                    'ee_read_private_venues',
-                    'ee_edit_venues',
-                    'ee_edit_others_venues',
-                    'ee_edit_published_venues',
-                    'ee_edit_private_venues',
-                    'ee_delete_venues',
-                    'ee_delete_others_venues',
-                    'ee_delete_private_venues',
-                    'ee_delete_published_venues',
-                    // venue categories
-                    'ee_manage_venue_categories',
-                    'ee_edit_venue_category',
-                    'ee_delete_venue_category',
-                    'ee_assign_venue_category',
-                    // contacts
-                    'ee_read_contacts',
-                    'ee_edit_contacts',
-                    'ee_delete_contacts',
-                    // registrations
-                    'ee_read_registrations',
-                    'ee_read_others_registrations',
-                    'ee_edit_registrations',
-                    'ee_edit_others_registrations',
-                    'ee_delete_registrations',
-                    'ee_delete_others_registrations',
-                    // checkins
-                    'ee_read_others_checkins',
-                    'ee_read_checkins',
-                    'ee_edit_checkins',
-                    'ee_edit_others_checkins',
-                    'ee_delete_checkins',
-                    'ee_delete_others_checkins',
-                    // transactions && payments
-                    'ee_read_transaction',
-                    'ee_read_transactions',
-                    'ee_edit_payments',
-                    'ee_delete_payments',
-                    // messages
-                    'ee_read_messages',
-                    'ee_read_others_messages',
-                    'ee_read_global_messages',
-                    'ee_edit_global_messages',
-                    'ee_edit_messages',
-                    'ee_edit_others_messages',
-                    'ee_delete_messages',
-                    'ee_delete_others_messages',
-                    'ee_delete_global_messages',
-                    'ee_send_message',
-                    // tickets
-                    'ee_read_default_tickets',
-                    'ee_read_others_default_tickets',
-                    'ee_edit_default_tickets',
-                    'ee_edit_others_default_tickets',
-                    'ee_delete_default_tickets',
-                    'ee_delete_others_default_tickets',
-                    // prices
-                    'ee_edit_default_price',
-                    'ee_edit_default_prices',
-                    'ee_delete_default_price',
-                    'ee_delete_default_prices',
-                    'ee_edit_default_price_type',
-                    'ee_edit_default_price_types',
-                    'ee_delete_default_price_type',
-                    'ee_delete_default_price_types',
-                    'ee_read_default_prices',
-                    'ee_read_default_price_types',
-                    // registration form
-                    'ee_edit_questions',
-                    'ee_edit_system_questions',
-                    'ee_read_questions',
-                    'ee_delete_questions',
-                    'ee_edit_question_groups',
-                    'ee_read_question_groups',
-                    'ee_edit_system_question_groups',
-                    'ee_delete_question_groups',
-                    // event_type taxonomy
-                    'ee_assign_event_type',
-                    'ee_manage_event_types',
-                    'ee_edit_event_type',
-                    'ee_delete_event_type',
-                ],
-                EE_Capabilities::ROLE_EVENTS_ADMINISTRATOR => [
-                    // core wp caps
-                    'read',
-                    'read_private_pages',
-                    'read_private_posts',
-                    'edit_users',
-                    'edit_posts',
-                    'edit_pages',
-                    'edit_published_posts',
-                    'edit_published_pages',
-                    'edit_private_pages',
-                    'edit_private_posts',
-                    'edit_others_posts',
-                    'edit_others_pages',
-                    'publish_posts',
-                    'publish_pages',
-                    'delete_posts',
-                    'delete_pages',
-                    'delete_private_pages',
-                    'delete_private_posts',
-                    'delete_published_pages',
-                    'delete_published_posts',
-                    'delete_others_posts',
-                    'delete_others_pages',
-                    'manage_categories',
-                    'manage_links',
-                    'moderate_comments',
-                    'unfiltered_html',
-                    'upload_files',
-                    'export',
-                    'import',
-                    'list_users',
-                    'level_1', // required if user with this role shows up in author dropdowns
-                    // basic ee access
-                    'ee_read_ee',
-                    // events
-                    'ee_publish_events',
-                    'ee_read_private_events',
-                    'ee_read_others_events',
-                    'ee_read_event',
-                    'ee_read_events',
-                    'ee_edit_event',
-                    'ee_edit_events',
-                    'ee_edit_published_events',
-                    'ee_edit_others_events',
-                    'ee_edit_private_events',
-                    'ee_delete_published_events',
-                    'ee_delete_private_events',
-                    'ee_delete_event',
-                    'ee_delete_events',
-                    'ee_delete_others_events',
-                    // event categories
-                    'ee_manage_event_categories',
-                    'ee_edit_event_category',
-                    'ee_delete_event_category',
-                    'ee_assign_event_category',
-                    // venues
-                    'ee_publish_venues',
-                    'ee_read_venue',
-                    'ee_read_venues',
-                    'ee_read_others_venues',
-                    'ee_read_private_venues',
-                    'ee_edit_venue',
-                    'ee_edit_venues',
-                    'ee_edit_others_venues',
-                    'ee_edit_published_venues',
-                    'ee_edit_private_venues',
-                    'ee_delete_venue',
-                    'ee_delete_venues',
-                    'ee_delete_others_venues',
-                    'ee_delete_private_venues',
-                    'ee_delete_published_venues',
-                    // venue categories
-                    'ee_manage_venue_categories',
-                    'ee_edit_venue_category',
-                    'ee_delete_venue_category',
-                    'ee_assign_venue_category',
-                    // contacts
-                    'ee_read_contacts',
-                    'ee_edit_contacts',
-                    'ee_delete_contacts',
-                    // registrations
-                    'ee_read_registrations',
-                    'ee_read_others_registrations',
-                    'ee_edit_registration',
-                    'ee_edit_registrations',
-                    'ee_edit_others_registrations',
-                    'ee_delete_registration',
-                    'ee_delete_registrations',
-                    'ee_delete_others_registrations',
-                    // checkins
-                    'ee_read_others_checkins',
-                    'ee_read_checkins',
-                    'ee_edit_checkins',
-                    'ee_edit_others_checkins',
-                    'ee_delete_checkins',
-                    'ee_delete_others_checkins',
-                    // transactions && payments
-                    'ee_read_transaction',
-                    'ee_read_transactions',
-                    'ee_edit_payments',
-                    'ee_delete_payments',
-                    // messages
-                    'ee_read_messages',
-                    'ee_read_others_messages',
-                    'ee_read_global_messages',
-                    'ee_edit_global_messages',
-                    'ee_edit_messages',
-                    'ee_edit_others_messages',
-                    'ee_delete_messages',
-                    'ee_delete_others_messages',
-                    'ee_delete_global_messages',
-                    'ee_send_message',
-                    // tickets
-                    'ee_read_default_tickets',
-                    'ee_read_others_default_tickets',
-                    'ee_edit_default_tickets',
-                    'ee_edit_others_default_tickets',
-                    'ee_delete_default_tickets',
-                    'ee_delete_others_default_tickets',
-                    // prices
-                    'ee_edit_default_price',
-                    'ee_edit_default_prices',
-                    'ee_delete_default_price',
-                    'ee_delete_default_prices',
-                    'ee_edit_default_price_type',
-                    'ee_edit_default_price_types',
-                    'ee_delete_default_price_type',
-                    'ee_delete_default_price_types',
-                    'ee_read_default_prices',
-                    'ee_read_default_price_types',
-                    // registration form
-                    'ee_edit_questions',
-                    'ee_edit_system_questions',
-                    'ee_read_questions',
-                    'ee_delete_questions',
-                    'ee_edit_question_groups',
-                    'ee_read_question_groups',
-                    'ee_edit_system_question_groups',
-                    'ee_delete_question_groups',
-                    // event_type taxonomy
-                    'ee_assign_event_type',
-                    'ee_manage_event_types',
-                    'ee_edit_event_type',
-                    'ee_delete_event_type',
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     */
-    private function setupCapabilitiesMap(): bool
-    {
-        // if the initialization process hasn't even started, then we need to call init_caps()
-        if ($this->initialized === null) {
-            return $this->init_caps();
-        }
-        // unless resetting, get caps from db if we haven't already
-        $this->capabilities_map = $this->reset || ! empty($this->capabilities_map)
-            ? $this->capabilities_map
-            : get_option(self::option_name, []);
-        return true;
-    }
-
-
-    /**
-     * @param bool $update
-     * @return bool
-     */
-    private function updateCapabilitiesMap(bool $update = true): bool
-    {
-        return $update && update_option(self::option_name, $this->capabilities_map);
-    }
-
-
-    /**
-     * Adds capabilities to roles.
-     *
-     * @param array $capabilities_to_add array of capabilities to add, indexed by roles.
-     *                                   Note that this should ONLY be called on activation hook
-     *                                   otherwise the caps will be added on every request.
-     * @return bool
-     * @throws EE_Error
-     * @since 4.9.42
-     */
-    public function addCaps(array $capabilities_to_add): bool
-    {
-        // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
-            return false;
-        }
-        // and filter the array so others can get in on the fun during resets
-        $capabilities_to_add     = apply_filters(
-            'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
-            $capabilities_to_add,
-            $this->reset,
-            $this->capabilities_map
-        );
-        $update_capabilities_map = false;
-        // if not reset, see what caps are new for each role. if they're new, add them.
-        foreach ($capabilities_to_add as $role => $caps_for_role) {
-            if (is_array($caps_for_role)) {
-                foreach ($caps_for_role as $cap) {
-                    if (
-                        ! $this->capHasBeenAddedToRole($role, $cap)
-                        && $this->add_cap_to_role($role, $cap, true, false)
-                    ) {
-                        $update_capabilities_map = true;
-                    }
-                }
-            }
-        }
-        // now let's just save the cap that has been set but only if there's been a change.
-        $updated = $this->updateCapabilitiesMap($update_capabilities_map);
-        $this->flushWpUser($updated);
-        do_action('AHEE__EE_Capabilities__addCaps__complete', $this->capabilities_map, $updated);
-        return $updated;
-    }
-
-
-    /**
-     * Loops through the capabilities map and removes the role caps specified by the incoming array
-     *
-     * @param array $caps_map map of capabilities to be removed (indexed by roles)
-     * @return bool
-     * @throws EE_Error
-     */
-    public function removeCaps(array $caps_map): bool
-    {
-        // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
-            return false;
-        }
-        $update_capabilities_map = false;
-        foreach ($caps_map as $role => $caps_for_role) {
-            if (is_array($caps_for_role)) {
-                foreach ($caps_for_role as $cap) {
-                    if (
-                        $this->capHasBeenAddedToRole($role, $cap)
-                        && $this->remove_cap_from_role($role, $cap, false)
-                    ) {
-                        $update_capabilities_map = true;
-                    }
-                }
-            }
-        }
-        // maybe resave the caps
-        $updated = $this->updateCapabilitiesMap($update_capabilities_map);
-        $this->flushWpUser($updated);
-        return $updated;
-    }
-
-
-    /**
-     * This ensures that the WP User object cached on the $current_user global in WP has the latest capabilities from
-     * the roles on that user.
-     *
-     * @param bool $flush Default is to flush the WP_User object.  If false, then this method effectively does nothing.
-     */
-    private function flushWpUser(bool $flush = true)
-    {
-        if ($flush) {
-            $user = wp_get_current_user();
-            if ($user instanceof WP_User) {
-                $user->get_role_caps();
-            }
-        }
-    }
-
-
-    /**
-     * This method sets a capability on a role.  Note this should only be done on activation, or if you have something
-     * specific to prevent the cap from being added on every page load (adding caps are persistent to the db). Note.
-     * this is a wrapper for $wp_role->add_cap()
-     *
-     * @param string|WP_Role $role  A WordPress role the capability is being added to
-     * @param string         $cap   The capability being added to the role
-     * @param bool           $grant Whether to grant access to this cap on this role.
-     * @param bool           $update_capabilities_map
-     * @return bool
-     * @throws EE_Error
-     * @see   wp-includes/capabilities.php
-     * @since 4.5.0
-     */
-    public function add_cap_to_role(
-        $role,
-        string $cap,
-        bool $grant = true,
-        bool $update_capabilities_map = true
-    ): bool {
-        // capture incoming value for $role because we may need it to create a new WP_Role
-        $orig_role = $role;
-        $role      = $role instanceof WP_Role ? $role : get_role($role);
-        // if the role isn't available then we create it.
-        if (! $role instanceof WP_Role) {
-            // if a plugin wants to create a specific role name then they should create the role before
-            // EE_Capabilities does.  Otherwise this function will create the role name from the slug:
-            // - removes any `ee_` namespacing from the start of the slug.
-            // - replaces `_` with ` ` (empty space).
-            // - sentence case on the resulting string.
-            $role_label = ucwords(str_replace(['ee_', '_'], ['', ' '], $orig_role));
-            $role       = add_role($orig_role, $role_label);
-        }
-        if ($role instanceof WP_Role) {
-            // don't do anything if the capabilities map can not be initialized
-            if (! $this->setupCapabilitiesMap()) {
-                return false;
-            }
-            if (! $this->capHasBeenAddedToRole($role->name, $cap)) {
-                $role->add_cap($cap, $grant);
-                $this->capabilities_map[ $role->name ][] = $cap;
-                $this->updateCapabilitiesMap($update_capabilities_map);
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Functions similarly to add_cap_to_role except removes cap from given role.
-     * Wrapper for $wp_role->remove_cap()
-     *
-     * @param string|WP_Role $role A WordPress role the capability is being removed from.
-     * @param string         $cap  The capability being removed
-     * @param bool           $update_capabilities_map
-     * @return bool
-     * @throws EE_Error
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     */
-    public function remove_cap_from_role($role, string $cap, bool $update_capabilities_map = true): bool
-    {
-        // don't do anything if the capabilities map can not be initialized
-        if (! $this->setupCapabilitiesMap()) {
-            return false;
-        }
-
-        $role = $role instanceof WP_Role ? $role : get_role($role);
-        if ($role instanceof WP_Role && $index = $this->capHasBeenAddedToRole($role->name, $cap, true)) {
-            $role->remove_cap($cap);
-            unset($this->capabilities_map[ $role->name ][ $index ]);
-            $this->updateCapabilitiesMap($update_capabilities_map);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * @param string $role_name
-     * @param string $cap
-     * @param bool   $get_index
-     * @return bool|int|string
-     */
-    private function capHasBeenAddedToRole(string $role_name = '', string $cap = '', bool $get_index = false)
-    {
-        if (
-            isset($this->capabilities_map[ $role_name ])
-            && ($index = array_search($cap, $this->capabilities_map[ $role_name ], true)) !== false
-        ) {
-            return $get_index ? $index : true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Wrapper for the native WP current_user_can() method.
-     * This is provided as a handy method for a couple things:
-     * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
-     * write those filters wherever current_user_can is called).
-     * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
-     *
-     * @param string     $cap     The cap being checked.
-     * @param string     $context The context where the current_user_can is being called from.
-     * @param int|string $id      [optional] ID for entity where current_user_can() is being called from
-     *                            (used in map_meta_cap() filters).
-     * @return bool  Whether user can or not.
-     * @since 4.5.0
-     */
-    public function current_user_can(string $cap, string $context, $id = 0): bool
-    {
-        // apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can__cap',
-            apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id),
-            $context,
-            $cap,
-            $id
-        );
-        return ! empty($id) ? current_user_can($filtered_cap, $id) : current_user_can($filtered_cap);
-    }
-
-
-    /**
-     * This is a wrapper for the WP user_can() function and follows the same style as the other wrappers in this class.
-     *
-     * @param int|WP_User $user    Either the user_id or a WP_User object
-     * @param string      $cap     The capability string being checked
-     * @param string      $context The context where the user_can is being called from (used in filters).
-     * @param int         $id      Optional. Id for item where user_can is being called from ( used in map_meta_cap()
-     *                             filters)
-     * @return bool Whether user can or not.
-     */
-    public function user_can($user, string $cap, string $context, int $id = 0): bool
-    {
-        // apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id);
-        $filtered_cap = apply_filters(
-            'FHEE__EE_Capabilities__user_can__cap',
-            $filtered_cap,
-            $context,
-            $cap,
-            $user,
-            $id
-        );
-        return ! empty($id) ? user_can($user, $filtered_cap, $id) : user_can($user, $filtered_cap);
-    }
-
-
-    /**
-     * Wrapper for the native WP current_user_can_for_blog() method.
-     * This is provided as a handy method for a couple things:
-     * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
-     * write those filters wherever current_user_can is called).
-     * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
-     *
-     * @param int    $blog_id The blog id that is being checked for.
-     * @param string $cap     The cap being checked.
-     * @param string $context The context where the current_user_can is being called from.
-     * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
-     *                        filters.
-     * @return bool  Whether user can or not.
-     * @since 4.5.0
-     */
-    public function current_user_can_for_blog(int $blog_id, string $cap, string $context, int $id = 0): bool
-    {
-        $user_can = ! empty($id) ? current_user_can_for_blog($blog_id, $cap, $id) : current_user_can($blog_id, $cap);
-        // apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-        $user_can = apply_filters(
-            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context,
-            $user_can,
-            $blog_id,
-            $cap,
-            $id
-        );
-        return apply_filters(
-            'FHEE__EE_Capabilities__current_user_can_for_blog__user_can',
-            $user_can,
-            $context,
-            $blog_id,
-            $cap,
-            $id
-        );
-    }
-
-
-    /**
-     * This helper method just returns an array of registered EE capabilities.
-     *
-     * @param string|null $role If empty then the entire role/capability map is returned.
-     *                          Otherwise just the capabilities for the given role are returned.
-     * @return array
-     * @throws EE_Error
-     * @since 4.5.0
-     */
-    public function get_ee_capabilities(?string $role = EE_Capabilities::ROLE_ADMINISTRATOR): array
-    {
-        if (! $this->initialized) {
-            $this->init_caps();
-        }
-        if ($role === '') {
-            return $this->capabilities_map;
-        }
-        return $this->capabilities_map[ $role ] ?? [];
-    }
-
-
-    /**
-     * @param bool  $reset      If you need to reset Event Espresso's capabilities,
-     *                          then please use the init_caps() method with the "$reset" parameter set to "true"
-     * @param array $caps_map   Optional.
-     *                          Can be used to send a custom map of roles and capabilities for setting them up.
-     *                          Note that this should ONLY be called on activation hook or some other one-time
-     *                          task otherwise the caps will be added on every request.
-     * @return void
-     * @throws EE_Error
-     * @deprecated 4.9.42
-     */
-    public function init_role_caps(bool $reset = false, array $caps_map = [])
-    {
-        // If this method is called directly and reset is set as 'true',
-        // then display a doing it wrong notice, because we want resets to go through init_caps()
-        // to guarantee that everything is set up correctly.
-        // This prevents the capabilities map getting reset incorrectly by direct calls to this method.
-        if ($reset) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" parameter for the "%2$s" method is deprecated. If you need to reset Event Espresso\'s capabilities, then please use the "%3$s" method with the "%1$s" parameter set to "%4$s".',
-                        'event_espresso'
-                    ),
-                    '$reset',
-                    __METHOD__ . '()',
-                    'EE_Capabilities::init_caps()',
-                    'true'
-                ),
-                '4.9.42',
-                '5.0.0'
-            );
-        }
-        $this->addCaps($caps_map);
-    }
+	const ROLE_ADMINISTRATOR = 'administrator';
+
+	const ROLE_EVENTS_ADMINISTRATOR = 'ee_events_administrator';
+
+
+	/**
+	 * the name of the wp option used to store caps previously initialized
+	 */
+	const option_name = 'ee_caps_initialized';
+
+	private static ?EE_Capabilities $_instance = null;
+
+
+	/**
+	 * This is a map of caps that correspond to a default WP_Role.
+	 * Array is indexed by Role and values are ee capabilities.
+	 *
+	 * @since 4.5.0
+	 * @var array
+	 */
+	private array $capabilities_map = [];
+
+	/**
+	 * This used to hold an array of EE_Meta_Capability_Map objects
+	 * that define the granular capabilities mapped to for a user depending on context.
+	 *
+	 * @var EE_Meta_Capability_Map[]
+	 */
+	private array $_meta_caps = [];
+
+	/**
+	 * The internal $capabilities_map needs to be initialized before it can be used.
+	 * This flag tracks whether that has happened or not.
+	 * But for this to work, we need three states to indicate:
+	 *      initialization has not occurred at all
+	 *      initialization has started but is not complete
+	 *      initialization is complete
+	 * The reason this is needed is because the addCaps() method
+	 * normally requires the $capabilities_map to be initialized,
+	 * but is also used during the initialization process.
+	 * So:
+	 *      If initialized === null, init_caps() will be called before any other methods will run.
+	 *      If initialized === false, then init_caps() is in the process of running it's logic.
+	 *      If initialized === true, then init_caps() has completed the initialization process.
+	 *
+	 * @var boolean|null $initialized
+	 */
+	private ?bool $initialized = null;
+
+	/**
+	 * @var boolean $reset
+	 */
+	private bool $reset = false;
+
+
+	/**
+	 * singleton method used to instantiate class object
+	 *
+	 * @return EE_Capabilities
+	 * @since 4.5.0
+	 */
+	public static function instance(): EE_Capabilities
+	{
+		// check if instantiated, and if not do so.
+		if (! self::$_instance instanceof EE_Capabilities) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * private constructor
+	 *
+	 * @since 4.5.0
+	 */
+	private function __construct()
+	{
+	}
+
+
+	/**
+	 * This delays the initialization of the capabilities class until EE_System core is loaded and ready.
+	 *
+	 * @param bool $reset allows for resetting the default capabilities saved on roles.  Note that this doesn't
+	 *                    actually REMOVE any capabilities from existing roles, it just resaves defaults roles and
+	 *                    ensures that they are up to date.
+	 * @since 4.5.0
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function init_caps(?bool $reset = false): bool
+	{
+		if (DbStatus::isOffline()) {
+			return false;
+		}
+		$this->reset = filter_var($reset, FILTER_VALIDATE_BOOLEAN);
+		// if reset, then completely delete the cache option and clear the $capabilities_map property.
+		if ($this->reset) {
+			$this->initialized      = null;
+			$this->capabilities_map = [];
+			delete_option(self::option_name);
+		}
+		if ($this->initialized === null) {
+			$this->initialized = false;
+			do_action(
+				'AHEE__EE_Capabilities__init_caps__before_initialization',
+				$this->reset
+			);
+			$this->addCaps($this->_init_caps_map());
+			$this->_set_meta_caps();
+			do_action(
+				'AHEE__EE_Capabilities__init_caps__after_initialization',
+				$this->capabilities_map
+			);
+			$this->initialized = true;
+		}
+		// reset $this->reset so that it's not stuck on true if init_caps() gets called again
+		$this->reset = false;
+		return true;
+	}
+
+
+	/**
+	 * This sets the meta caps property.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @since 4.5.0
+	 */
+	private function _set_meta_caps()
+	{
+		// get default meta caps and filter the returned array
+		$this->_meta_caps = apply_filters(
+			'FHEE__EE_Capabilities___set_meta_caps__meta_caps',
+			$this->_get_default_meta_caps_array()
+		);
+		// add filter for map_meta_caps but only if models can query.
+		if (! has_filter('map_meta_cap', [$this, 'map_meta_caps'])) {
+			add_filter('map_meta_cap', [$this, 'map_meta_caps'], 10, 4);
+		}
+	}
+
+
+	/**
+	 * This builds and returns the default meta_caps array only once.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @since  4.8.28.rc.012
+	 */
+	private function _get_default_meta_caps_array(): array
+	{
+		static $default_meta_caps = [];
+		// make sure we're only ever initializing the default _meta_caps array once if it's empty.
+		if (empty($default_meta_caps)) {
+			$default_meta_caps = [
+				// edits
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_event',
+					['Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events']
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_venue',
+					['Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues']
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_registration',
+					['Registration', '', 'ee_edit_others_registrations', '']
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_checkin',
+					['Registration', '', 'ee_edit_others_checkins', '']
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_edit_message',
+					['Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages']
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_default_ticket',
+					['Ticket', '', 'ee_edit_others_default_tickets', '']
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_edit_question',
+					['Question', '', '', 'ee_edit_system_questions']
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_edit_question_group',
+					['Question_Group', '', '', 'ee_edit_system_question_groups']
+				),
+				new EE_Meta_Capability_Map_Edit(
+					'ee_edit_payment_method',
+					['Payment_Method', '', 'ee_edit_others_payment_methods', '']
+				),
+				// reads
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_event',
+					['Event', '', 'ee_read_others_events', 'ee_read_private_events']
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_venue',
+					['Venue', '', 'ee_read_others_venues', 'ee_read_private_venues']
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_registration',
+					['Registration', '', 'ee_read_others_registrations', '']
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_checkin',
+					['Registration', '', 'ee_read_others_checkins', '']
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_read_message',
+					['Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages']
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_default_ticket',
+					['Ticket', '', 'ee_read_others_default_tickets', '']
+				),
+				new EE_Meta_Capability_Map_Read(
+					'ee_read_payment_method',
+					['Payment_Method', '', 'ee_read_others_payment_methods', '']
+				),
+				// deletes
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_event',
+					[
+						'Event',
+						'ee_delete_published_events',
+						'ee_delete_others_events',
+						'ee_delete_private_events',
+					]
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_venue',
+					[
+						'Venue',
+						'ee_delete_published_venues',
+						'ee_delete_others_venues',
+						'ee_delete_private_venues',
+					]
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_registration',
+					['Registration', '', 'ee_delete_others_registrations', '']
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_checkin',
+					['Registration', '', 'ee_delete_others_checkins', '']
+				),
+				new EE_Meta_Capability_Map_Messages_Cap(
+					'ee_delete_message',
+					['Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages']
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_default_ticket',
+					['Ticket', '', 'ee_delete_others_default_tickets', '']
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_delete_question',
+					['Question', '', '', 'delete_system_questions']
+				),
+				new EE_Meta_Capability_Map_Registration_Form_Cap(
+					'ee_delete_question_group',
+					['Question_Group', '', '', 'delete_system_question_groups']
+				),
+				new EE_Meta_Capability_Map_Delete(
+					'ee_delete_payment_method',
+					['Payment_Method', '', 'ee_delete_others_payment_methods', '']
+				),
+			];
+		}
+		return $default_meta_caps;
+	}
+
+
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 * The actual logic is carried out by implementer classes in their definition of _map_meta_caps.
+	 *
+	 * @param array       $caps    actual users capabilities
+	 * @param string|null $cap     initial capability name that is being checked (the "map" key)
+	 * @param int         $user_id The user id
+	 * @param array       $args    Adds context to the cap. Typically the object ID.
+	 * @return array actual users capabilities
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 */
+	public function map_meta_caps(array $caps, ?string $cap, int $user_id, array $args): array
+	{
+		if (! $cap || ! did_action('AHEE__EE_System__load_espresso_addons__complete')) {
+			return $caps;
+		}
+		// loop through our _meta_caps array
+		foreach ($this->_meta_caps as $meta_map) {
+			if (! $meta_map instanceof EE_Meta_Capability_Map) {
+				continue;
+			}
+			// don't load models if there is no object ID in the args
+			if (! empty($args[0])) {
+				$meta_map->ensure_is_model();
+			}
+			$caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
+		}
+		return $caps;
+	}
+
+
+	/**
+	 * This sets up and returns the initial capabilities map for Event Espresso
+	 * Note this array is filtered.
+	 * It is assumed that all available EE capabilities are assigned to the administrator role.
+	 *
+	 * @return array
+	 * @since 4.5.0
+	 */
+	private function _init_caps_map(): array
+	{
+		return apply_filters(
+			'FHEE__EE_Capabilities__init_caps_map__caps',
+			[
+				EE_Capabilities::ROLE_ADMINISTRATOR        => [
+					// basic access
+					'ee_read_ee',
+					// gateways
+					// note that with payment method capabilities, although we've implemented
+					// capability mapping which will be used for accessing payment methods owned by
+					// other users.  This is not fully implemented yet in the payment method ui.
+					// Currently only the "plural" caps are in active use.
+					// (Specific payment method caps are in use as well).
+					'ee_manage_gateways',
+					'ee_read_payment_methods',
+					'ee_read_others_payment_methods',
+					'ee_edit_payment_methods',
+					'ee_edit_others_payment_methods',
+					'ee_delete_payment_methods',
+					// events
+					'ee_publish_events',
+					'ee_read_private_events',
+					'ee_read_others_events',
+					'ee_read_events',
+					'ee_edit_events',
+					'ee_edit_published_events',
+					'ee_edit_others_events',
+					'ee_edit_private_events',
+					'ee_delete_published_events',
+					'ee_delete_private_events',
+					'ee_delete_events',
+					'ee_delete_others_events',
+					// event categories
+					'ee_manage_event_categories',
+					'ee_edit_event_category',
+					'ee_delete_event_category',
+					'ee_assign_event_category',
+					// venues
+					'ee_publish_venues',
+					'ee_read_venues',
+					'ee_read_others_venues',
+					'ee_read_private_venues',
+					'ee_edit_venues',
+					'ee_edit_others_venues',
+					'ee_edit_published_venues',
+					'ee_edit_private_venues',
+					'ee_delete_venues',
+					'ee_delete_others_venues',
+					'ee_delete_private_venues',
+					'ee_delete_published_venues',
+					// venue categories
+					'ee_manage_venue_categories',
+					'ee_edit_venue_category',
+					'ee_delete_venue_category',
+					'ee_assign_venue_category',
+					// contacts
+					'ee_read_contacts',
+					'ee_edit_contacts',
+					'ee_delete_contacts',
+					// registrations
+					'ee_read_registrations',
+					'ee_read_others_registrations',
+					'ee_edit_registrations',
+					'ee_edit_others_registrations',
+					'ee_delete_registrations',
+					'ee_delete_others_registrations',
+					// checkins
+					'ee_read_others_checkins',
+					'ee_read_checkins',
+					'ee_edit_checkins',
+					'ee_edit_others_checkins',
+					'ee_delete_checkins',
+					'ee_delete_others_checkins',
+					// transactions && payments
+					'ee_read_transaction',
+					'ee_read_transactions',
+					'ee_edit_payments',
+					'ee_delete_payments',
+					// messages
+					'ee_read_messages',
+					'ee_read_others_messages',
+					'ee_read_global_messages',
+					'ee_edit_global_messages',
+					'ee_edit_messages',
+					'ee_edit_others_messages',
+					'ee_delete_messages',
+					'ee_delete_others_messages',
+					'ee_delete_global_messages',
+					'ee_send_message',
+					// tickets
+					'ee_read_default_tickets',
+					'ee_read_others_default_tickets',
+					'ee_edit_default_tickets',
+					'ee_edit_others_default_tickets',
+					'ee_delete_default_tickets',
+					'ee_delete_others_default_tickets',
+					// prices
+					'ee_edit_default_price',
+					'ee_edit_default_prices',
+					'ee_delete_default_price',
+					'ee_delete_default_prices',
+					'ee_edit_default_price_type',
+					'ee_edit_default_price_types',
+					'ee_delete_default_price_type',
+					'ee_delete_default_price_types',
+					'ee_read_default_prices',
+					'ee_read_default_price_types',
+					// registration form
+					'ee_edit_questions',
+					'ee_edit_system_questions',
+					'ee_read_questions',
+					'ee_delete_questions',
+					'ee_edit_question_groups',
+					'ee_read_question_groups',
+					'ee_edit_system_question_groups',
+					'ee_delete_question_groups',
+					// event_type taxonomy
+					'ee_assign_event_type',
+					'ee_manage_event_types',
+					'ee_edit_event_type',
+					'ee_delete_event_type',
+				],
+				EE_Capabilities::ROLE_EVENTS_ADMINISTRATOR => [
+					// core wp caps
+					'read',
+					'read_private_pages',
+					'read_private_posts',
+					'edit_users',
+					'edit_posts',
+					'edit_pages',
+					'edit_published_posts',
+					'edit_published_pages',
+					'edit_private_pages',
+					'edit_private_posts',
+					'edit_others_posts',
+					'edit_others_pages',
+					'publish_posts',
+					'publish_pages',
+					'delete_posts',
+					'delete_pages',
+					'delete_private_pages',
+					'delete_private_posts',
+					'delete_published_pages',
+					'delete_published_posts',
+					'delete_others_posts',
+					'delete_others_pages',
+					'manage_categories',
+					'manage_links',
+					'moderate_comments',
+					'unfiltered_html',
+					'upload_files',
+					'export',
+					'import',
+					'list_users',
+					'level_1', // required if user with this role shows up in author dropdowns
+					// basic ee access
+					'ee_read_ee',
+					// events
+					'ee_publish_events',
+					'ee_read_private_events',
+					'ee_read_others_events',
+					'ee_read_event',
+					'ee_read_events',
+					'ee_edit_event',
+					'ee_edit_events',
+					'ee_edit_published_events',
+					'ee_edit_others_events',
+					'ee_edit_private_events',
+					'ee_delete_published_events',
+					'ee_delete_private_events',
+					'ee_delete_event',
+					'ee_delete_events',
+					'ee_delete_others_events',
+					// event categories
+					'ee_manage_event_categories',
+					'ee_edit_event_category',
+					'ee_delete_event_category',
+					'ee_assign_event_category',
+					// venues
+					'ee_publish_venues',
+					'ee_read_venue',
+					'ee_read_venues',
+					'ee_read_others_venues',
+					'ee_read_private_venues',
+					'ee_edit_venue',
+					'ee_edit_venues',
+					'ee_edit_others_venues',
+					'ee_edit_published_venues',
+					'ee_edit_private_venues',
+					'ee_delete_venue',
+					'ee_delete_venues',
+					'ee_delete_others_venues',
+					'ee_delete_private_venues',
+					'ee_delete_published_venues',
+					// venue categories
+					'ee_manage_venue_categories',
+					'ee_edit_venue_category',
+					'ee_delete_venue_category',
+					'ee_assign_venue_category',
+					// contacts
+					'ee_read_contacts',
+					'ee_edit_contacts',
+					'ee_delete_contacts',
+					// registrations
+					'ee_read_registrations',
+					'ee_read_others_registrations',
+					'ee_edit_registration',
+					'ee_edit_registrations',
+					'ee_edit_others_registrations',
+					'ee_delete_registration',
+					'ee_delete_registrations',
+					'ee_delete_others_registrations',
+					// checkins
+					'ee_read_others_checkins',
+					'ee_read_checkins',
+					'ee_edit_checkins',
+					'ee_edit_others_checkins',
+					'ee_delete_checkins',
+					'ee_delete_others_checkins',
+					// transactions && payments
+					'ee_read_transaction',
+					'ee_read_transactions',
+					'ee_edit_payments',
+					'ee_delete_payments',
+					// messages
+					'ee_read_messages',
+					'ee_read_others_messages',
+					'ee_read_global_messages',
+					'ee_edit_global_messages',
+					'ee_edit_messages',
+					'ee_edit_others_messages',
+					'ee_delete_messages',
+					'ee_delete_others_messages',
+					'ee_delete_global_messages',
+					'ee_send_message',
+					// tickets
+					'ee_read_default_tickets',
+					'ee_read_others_default_tickets',
+					'ee_edit_default_tickets',
+					'ee_edit_others_default_tickets',
+					'ee_delete_default_tickets',
+					'ee_delete_others_default_tickets',
+					// prices
+					'ee_edit_default_price',
+					'ee_edit_default_prices',
+					'ee_delete_default_price',
+					'ee_delete_default_prices',
+					'ee_edit_default_price_type',
+					'ee_edit_default_price_types',
+					'ee_delete_default_price_type',
+					'ee_delete_default_price_types',
+					'ee_read_default_prices',
+					'ee_read_default_price_types',
+					// registration form
+					'ee_edit_questions',
+					'ee_edit_system_questions',
+					'ee_read_questions',
+					'ee_delete_questions',
+					'ee_edit_question_groups',
+					'ee_read_question_groups',
+					'ee_edit_system_question_groups',
+					'ee_delete_question_groups',
+					// event_type taxonomy
+					'ee_assign_event_type',
+					'ee_manage_event_types',
+					'ee_edit_event_type',
+					'ee_delete_event_type',
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	private function setupCapabilitiesMap(): bool
+	{
+		// if the initialization process hasn't even started, then we need to call init_caps()
+		if ($this->initialized === null) {
+			return $this->init_caps();
+		}
+		// unless resetting, get caps from db if we haven't already
+		$this->capabilities_map = $this->reset || ! empty($this->capabilities_map)
+			? $this->capabilities_map
+			: get_option(self::option_name, []);
+		return true;
+	}
+
+
+	/**
+	 * @param bool $update
+	 * @return bool
+	 */
+	private function updateCapabilitiesMap(bool $update = true): bool
+	{
+		return $update && update_option(self::option_name, $this->capabilities_map);
+	}
+
+
+	/**
+	 * Adds capabilities to roles.
+	 *
+	 * @param array $capabilities_to_add array of capabilities to add, indexed by roles.
+	 *                                   Note that this should ONLY be called on activation hook
+	 *                                   otherwise the caps will be added on every request.
+	 * @return bool
+	 * @throws EE_Error
+	 * @since 4.9.42
+	 */
+	public function addCaps(array $capabilities_to_add): bool
+	{
+		// don't do anything if the capabilities map can not be initialized
+		if (! $this->setupCapabilitiesMap()) {
+			return false;
+		}
+		// and filter the array so others can get in on the fun during resets
+		$capabilities_to_add     = apply_filters(
+			'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
+			$capabilities_to_add,
+			$this->reset,
+			$this->capabilities_map
+		);
+		$update_capabilities_map = false;
+		// if not reset, see what caps are new for each role. if they're new, add them.
+		foreach ($capabilities_to_add as $role => $caps_for_role) {
+			if (is_array($caps_for_role)) {
+				foreach ($caps_for_role as $cap) {
+					if (
+						! $this->capHasBeenAddedToRole($role, $cap)
+						&& $this->add_cap_to_role($role, $cap, true, false)
+					) {
+						$update_capabilities_map = true;
+					}
+				}
+			}
+		}
+		// now let's just save the cap that has been set but only if there's been a change.
+		$updated = $this->updateCapabilitiesMap($update_capabilities_map);
+		$this->flushWpUser($updated);
+		do_action('AHEE__EE_Capabilities__addCaps__complete', $this->capabilities_map, $updated);
+		return $updated;
+	}
+
+
+	/**
+	 * Loops through the capabilities map and removes the role caps specified by the incoming array
+	 *
+	 * @param array $caps_map map of capabilities to be removed (indexed by roles)
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function removeCaps(array $caps_map): bool
+	{
+		// don't do anything if the capabilities map can not be initialized
+		if (! $this->setupCapabilitiesMap()) {
+			return false;
+		}
+		$update_capabilities_map = false;
+		foreach ($caps_map as $role => $caps_for_role) {
+			if (is_array($caps_for_role)) {
+				foreach ($caps_for_role as $cap) {
+					if (
+						$this->capHasBeenAddedToRole($role, $cap)
+						&& $this->remove_cap_from_role($role, $cap, false)
+					) {
+						$update_capabilities_map = true;
+					}
+				}
+			}
+		}
+		// maybe resave the caps
+		$updated = $this->updateCapabilitiesMap($update_capabilities_map);
+		$this->flushWpUser($updated);
+		return $updated;
+	}
+
+
+	/**
+	 * This ensures that the WP User object cached on the $current_user global in WP has the latest capabilities from
+	 * the roles on that user.
+	 *
+	 * @param bool $flush Default is to flush the WP_User object.  If false, then this method effectively does nothing.
+	 */
+	private function flushWpUser(bool $flush = true)
+	{
+		if ($flush) {
+			$user = wp_get_current_user();
+			if ($user instanceof WP_User) {
+				$user->get_role_caps();
+			}
+		}
+	}
+
+
+	/**
+	 * This method sets a capability on a role.  Note this should only be done on activation, or if you have something
+	 * specific to prevent the cap from being added on every page load (adding caps are persistent to the db). Note.
+	 * this is a wrapper for $wp_role->add_cap()
+	 *
+	 * @param string|WP_Role $role  A WordPress role the capability is being added to
+	 * @param string         $cap   The capability being added to the role
+	 * @param bool           $grant Whether to grant access to this cap on this role.
+	 * @param bool           $update_capabilities_map
+	 * @return bool
+	 * @throws EE_Error
+	 * @see   wp-includes/capabilities.php
+	 * @since 4.5.0
+	 */
+	public function add_cap_to_role(
+		$role,
+		string $cap,
+		bool $grant = true,
+		bool $update_capabilities_map = true
+	): bool {
+		// capture incoming value for $role because we may need it to create a new WP_Role
+		$orig_role = $role;
+		$role      = $role instanceof WP_Role ? $role : get_role($role);
+		// if the role isn't available then we create it.
+		if (! $role instanceof WP_Role) {
+			// if a plugin wants to create a specific role name then they should create the role before
+			// EE_Capabilities does.  Otherwise this function will create the role name from the slug:
+			// - removes any `ee_` namespacing from the start of the slug.
+			// - replaces `_` with ` ` (empty space).
+			// - sentence case on the resulting string.
+			$role_label = ucwords(str_replace(['ee_', '_'], ['', ' '], $orig_role));
+			$role       = add_role($orig_role, $role_label);
+		}
+		if ($role instanceof WP_Role) {
+			// don't do anything if the capabilities map can not be initialized
+			if (! $this->setupCapabilitiesMap()) {
+				return false;
+			}
+			if (! $this->capHasBeenAddedToRole($role->name, $cap)) {
+				$role->add_cap($cap, $grant);
+				$this->capabilities_map[ $role->name ][] = $cap;
+				$this->updateCapabilitiesMap($update_capabilities_map);
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Functions similarly to add_cap_to_role except removes cap from given role.
+	 * Wrapper for $wp_role->remove_cap()
+	 *
+	 * @param string|WP_Role $role A WordPress role the capability is being removed from.
+	 * @param string         $cap  The capability being removed
+	 * @param bool           $update_capabilities_map
+	 * @return bool
+	 * @throws EE_Error
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 */
+	public function remove_cap_from_role($role, string $cap, bool $update_capabilities_map = true): bool
+	{
+		// don't do anything if the capabilities map can not be initialized
+		if (! $this->setupCapabilitiesMap()) {
+			return false;
+		}
+
+		$role = $role instanceof WP_Role ? $role : get_role($role);
+		if ($role instanceof WP_Role && $index = $this->capHasBeenAddedToRole($role->name, $cap, true)) {
+			$role->remove_cap($cap);
+			unset($this->capabilities_map[ $role->name ][ $index ]);
+			$this->updateCapabilitiesMap($update_capabilities_map);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * @param string $role_name
+	 * @param string $cap
+	 * @param bool   $get_index
+	 * @return bool|int|string
+	 */
+	private function capHasBeenAddedToRole(string $role_name = '', string $cap = '', bool $get_index = false)
+	{
+		if (
+			isset($this->capabilities_map[ $role_name ])
+			&& ($index = array_search($cap, $this->capabilities_map[ $role_name ], true)) !== false
+		) {
+			return $get_index ? $index : true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Wrapper for the native WP current_user_can() method.
+	 * This is provided as a handy method for a couple things:
+	 * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
+	 * write those filters wherever current_user_can is called).
+	 * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
+	 *
+	 * @param string     $cap     The cap being checked.
+	 * @param string     $context The context where the current_user_can is being called from.
+	 * @param int|string $id      [optional] ID for entity where current_user_can() is being called from
+	 *                            (used in map_meta_cap() filters).
+	 * @return bool  Whether user can or not.
+	 * @since 4.5.0
+	 */
+	public function current_user_can(string $cap, string $context, $id = 0): bool
+	{
+		// apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$filtered_cap = apply_filters(
+			'FHEE__EE_Capabilities__current_user_can__cap',
+			apply_filters('FHEE__EE_Capabilities__current_user_can__cap__' . $context, $cap, $id),
+			$context,
+			$cap,
+			$id
+		);
+		return ! empty($id) ? current_user_can($filtered_cap, $id) : current_user_can($filtered_cap);
+	}
+
+
+	/**
+	 * This is a wrapper for the WP user_can() function and follows the same style as the other wrappers in this class.
+	 *
+	 * @param int|WP_User $user    Either the user_id or a WP_User object
+	 * @param string      $cap     The capability string being checked
+	 * @param string      $context The context where the user_can is being called from (used in filters).
+	 * @param int         $id      Optional. Id for item where user_can is being called from ( used in map_meta_cap()
+	 *                             filters)
+	 * @return bool Whether user can or not.
+	 */
+	public function user_can($user, string $cap, string $context, int $id = 0): bool
+	{
+		// apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id);
+		$filtered_cap = apply_filters(
+			'FHEE__EE_Capabilities__user_can__cap',
+			$filtered_cap,
+			$context,
+			$cap,
+			$user,
+			$id
+		);
+		return ! empty($id) ? user_can($user, $filtered_cap, $id) : user_can($user, $filtered_cap);
+	}
+
+
+	/**
+	 * Wrapper for the native WP current_user_can_for_blog() method.
+	 * This is provided as a handy method for a couple things:
+	 * 1. Using the context string it allows for targeted filtering by addons for a specific check (without having to
+	 * write those filters wherever current_user_can is called).
+	 * 2. Explicit passing of $id from a given context ( useful in the cases of map_meta_cap filters )
+	 *
+	 * @param int    $blog_id The blog id that is being checked for.
+	 * @param string $cap     The cap being checked.
+	 * @param string $context The context where the current_user_can is being called from.
+	 * @param int    $id      Optional. Id for item where current_user_can is being called from (used in map_meta_cap()
+	 *                        filters.
+	 * @return bool  Whether user can or not.
+	 * @since 4.5.0
+	 */
+	public function current_user_can_for_blog(int $blog_id, string $cap, string $context, int $id = 0): bool
+	{
+		$user_can = ! empty($id) ? current_user_can_for_blog($blog_id, $cap, $id) : current_user_can($blog_id, $cap);
+		// apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
+		$user_can = apply_filters(
+			'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context,
+			$user_can,
+			$blog_id,
+			$cap,
+			$id
+		);
+		return apply_filters(
+			'FHEE__EE_Capabilities__current_user_can_for_blog__user_can',
+			$user_can,
+			$context,
+			$blog_id,
+			$cap,
+			$id
+		);
+	}
+
+
+	/**
+	 * This helper method just returns an array of registered EE capabilities.
+	 *
+	 * @param string|null $role If empty then the entire role/capability map is returned.
+	 *                          Otherwise just the capabilities for the given role are returned.
+	 * @return array
+	 * @throws EE_Error
+	 * @since 4.5.0
+	 */
+	public function get_ee_capabilities(?string $role = EE_Capabilities::ROLE_ADMINISTRATOR): array
+	{
+		if (! $this->initialized) {
+			$this->init_caps();
+		}
+		if ($role === '') {
+			return $this->capabilities_map;
+		}
+		return $this->capabilities_map[ $role ] ?? [];
+	}
+
+
+	/**
+	 * @param bool  $reset      If you need to reset Event Espresso's capabilities,
+	 *                          then please use the init_caps() method with the "$reset" parameter set to "true"
+	 * @param array $caps_map   Optional.
+	 *                          Can be used to send a custom map of roles and capabilities for setting them up.
+	 *                          Note that this should ONLY be called on activation hook or some other one-time
+	 *                          task otherwise the caps will be added on every request.
+	 * @return void
+	 * @throws EE_Error
+	 * @deprecated 4.9.42
+	 */
+	public function init_role_caps(bool $reset = false, array $caps_map = [])
+	{
+		// If this method is called directly and reset is set as 'true',
+		// then display a doing it wrong notice, because we want resets to go through init_caps()
+		// to guarantee that everything is set up correctly.
+		// This prevents the capabilities map getting reset incorrectly by direct calls to this method.
+		if ($reset) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'The "%1$s" parameter for the "%2$s" method is deprecated. If you need to reset Event Espresso\'s capabilities, then please use the "%3$s" method with the "%1$s" parameter set to "%4$s".',
+						'event_espresso'
+					),
+					'$reset',
+					__METHOD__ . '()',
+					'EE_Capabilities::init_caps()',
+					'true'
+				),
+				'4.9.42',
+				'5.0.0'
+			);
+		}
+		$this->addCaps($caps_map);
+	}
 }
 
 
@@ -991,136 +991,136 @@ 
  */
 abstract class EE_Meta_Capability_Map
 {
-    /**
-     * @var EEM_Base
-     */
-    protected $_model = null;
-
-    protected string $_model_name = '';
-
-    public string $meta_cap = '';
-
-    public string $published_cap = '';
-
-    public string $others_cap = '';
-
-    public string $private_cap = '';
-
-
-    /**
-     * constructor.
-     * Receives the setup arguments for the map.
-     *
-     * @param string $meta_cap       What meta capability is this mapping.
-     * @param array  $map_values     array {
-     *                               //array of values that MUST match a count of 4.  It's okay to send an empty string
-     *                               for capabilities that don't get mapped to.
-     * @type         $map_values     [0] string A string representing the model name. Required.  String's
-     *                               should always be used when Menu Maps are registered via the
-     *                               plugin API as models are not allowed to be instantiated when
-     *                               in maintenance mode 2 (migrations).
-     * @type         $map_values     [1] string represents the capability used for published. Optional.
-     * @type         $map_values     [2] string represents the capability used for "others". Optional.
-     * @type         $map_values     [3] string represents the capability used for private. Optional.
-     *                               }
-     * @throws EE_Error
-     * @since                        4.5.0
-     */
-    public function __construct(string $meta_cap, array $map_values)
-    {
-        $this->meta_cap = $meta_cap;
-        // verify there are four args in the $map_values array;
-        if (count($map_values) !== 4) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Incoming $map_values array should have a count of four values in it.  This is what was given: %s',
-                        'event_espresso'
-                    ),
-                    '<br>' . print_r($map_values, true)
-                )
-            );
-        }
-        // set properties
-        $this->_model        = null;
-        $this->_model_name   = $map_values[0];
-        $this->published_cap = (string) $map_values[1];
-        $this->others_cap    = (string) $map_values[2];
-        $this->private_cap   = (string) $map_values[3];
-    }
-
-
-    /**
-     * Makes it so this object stops filtering caps
-     */
-    public function remove_filters()
-    {
-        remove_filter('map_meta_cap', [$this, 'map_meta_caps']);
-    }
-
-
-    /**
-     * This method ensures that the $model property is converted from the model name string to a proper EEM_Base class
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.5.0
-     */
-    public function ensure_is_model()
-    {
-        // is it already instantiated?
-        if ($this->_model instanceof EEM_Base) {
-            return;
-        }
-        // ensure model name is string
-        $this->_model_name = (string) $this->_model_name;
-        // error proof if the name has EEM in it
-        $this->_model_name = str_replace('EEM', '', $this->_model_name);
-        $this->_model      = EE_Registry::instance()->load_model($this->_model_name);
-        if (! $this->_model instanceof EEM_Base) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class.   Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    $this->_model
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @param array       $caps    actual users capabilities
-     * @param string|null $cap     initial capability name that is being checked (the "map" key)
-     * @param int         $user_id The user id
-     * @param array       $args    Adds context to the cap. Typically the object ID.
-     * @return array
-     * @since 4.6.x
-     * @see   EE_Meta_Capability_Map::_map_meta_caps() for docs on params.
-     */
-    public function map_meta_caps(array $caps, ?string $cap, int $user_id, array $args): array
-    {
-        return $this->_map_meta_caps($caps, $cap, $user_id, $args);
-    }
-
-
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     * @return array   actual users capabilities
-     * @see   wp-includes/capabilities.php
-     * @since 4.5.0
-     */
-    abstract protected function _map_meta_caps(array $caps, string $cap, int $user_id, array $args): array;
+	/**
+	 * @var EEM_Base
+	 */
+	protected $_model = null;
+
+	protected string $_model_name = '';
+
+	public string $meta_cap = '';
+
+	public string $published_cap = '';
+
+	public string $others_cap = '';
+
+	public string $private_cap = '';
+
+
+	/**
+	 * constructor.
+	 * Receives the setup arguments for the map.
+	 *
+	 * @param string $meta_cap       What meta capability is this mapping.
+	 * @param array  $map_values     array {
+	 *                               //array of values that MUST match a count of 4.  It's okay to send an empty string
+	 *                               for capabilities that don't get mapped to.
+	 * @type         $map_values     [0] string A string representing the model name. Required.  String's
+	 *                               should always be used when Menu Maps are registered via the
+	 *                               plugin API as models are not allowed to be instantiated when
+	 *                               in maintenance mode 2 (migrations).
+	 * @type         $map_values     [1] string represents the capability used for published. Optional.
+	 * @type         $map_values     [2] string represents the capability used for "others". Optional.
+	 * @type         $map_values     [3] string represents the capability used for private. Optional.
+	 *                               }
+	 * @throws EE_Error
+	 * @since                        4.5.0
+	 */
+	public function __construct(string $meta_cap, array $map_values)
+	{
+		$this->meta_cap = $meta_cap;
+		// verify there are four args in the $map_values array;
+		if (count($map_values) !== 4) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Incoming $map_values array should have a count of four values in it.  This is what was given: %s',
+						'event_espresso'
+					),
+					'<br>' . print_r($map_values, true)
+				)
+			);
+		}
+		// set properties
+		$this->_model        = null;
+		$this->_model_name   = $map_values[0];
+		$this->published_cap = (string) $map_values[1];
+		$this->others_cap    = (string) $map_values[2];
+		$this->private_cap   = (string) $map_values[3];
+	}
+
+
+	/**
+	 * Makes it so this object stops filtering caps
+	 */
+	public function remove_filters()
+	{
+		remove_filter('map_meta_cap', [$this, 'map_meta_caps']);
+	}
+
+
+	/**
+	 * This method ensures that the $model property is converted from the model name string to a proper EEM_Base class
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 */
+	public function ensure_is_model()
+	{
+		// is it already instantiated?
+		if ($this->_model instanceof EEM_Base) {
+			return;
+		}
+		// ensure model name is string
+		$this->_model_name = (string) $this->_model_name;
+		// error proof if the name has EEM in it
+		$this->_model_name = str_replace('EEM', '', $this->_model_name);
+		$this->_model      = EE_Registry::instance()->load_model($this->_model_name);
+		if (! $this->_model instanceof EEM_Base) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class.   Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s',
+						'event_espresso'
+					),
+					get_class($this),
+					$this->_model
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @param array       $caps    actual users capabilities
+	 * @param string|null $cap     initial capability name that is being checked (the "map" key)
+	 * @param int         $user_id The user id
+	 * @param array       $args    Adds context to the cap. Typically the object ID.
+	 * @return array
+	 * @since 4.6.x
+	 * @see   EE_Meta_Capability_Map::_map_meta_caps() for docs on params.
+	 */
+	public function map_meta_caps(array $caps, ?string $cap, int $user_id, array $args): array
+	{
+		return $this->_map_meta_caps($caps, $cap, $user_id, $args);
+	}
+
+
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 * @return array   actual users capabilities
+	 * @see   wp-includes/capabilities.php
+	 * @since 4.5.0
+	 */
+	abstract protected function _map_meta_caps(array $caps, string $cap, int $user_id, array $args): array;
 }
 
 
@@ -1135,78 +1135,78 @@ 
  */
 class EE_Meta_Capability_Map_Edit extends EE_Meta_Capability_Map
 {
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     * @return array   actual users capabilities
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     */
-    protected function _map_meta_caps(array $caps, string $cap, int $user_id, array $args): array
-    {
-        // only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        // okay it is a meta cap so let's first remove that cap from the $caps array.
-        if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[ $key ]);
-        }
-
-        /** @var EE_Base_Class $obj */
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        // if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = 'do_not_allow';
-            return $caps;
-        }
-        $caps[] = $cap . 's';
-        if ($obj instanceof EE_CPT_Base) {
-            // if the item author is set and the user is the author...
-            if ($obj->wp_user() && $user_id === $obj->wp_user()) {
-                // if obj is published...
-                if ($obj->status() === 'publish') {
-                    $caps[] = $this->published_cap;
-                }
-            } else {
-                // the user is trying to edit someone else's obj
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-                if (! empty($this->published_cap) && $obj->status() === 'publish') {
-                    $caps[] = $this->published_cap;
-                } elseif (! empty($this->private_cap) && $obj->status() === 'private') {
-                    $caps[] = $this->private_cap;
-                }
-            }
-        } else {
-            // not a cpt object so handled differently
-            $has_cap = false;
-            try {
-                $has_cap = method_exists($obj, 'wp_user')
-                           && $obj->wp_user()
-                           && $obj->wp_user() === $user_id;
-            } catch (Exception $e) {
-                if (WP_DEBUG) {
-                    EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-            if (! $has_cap) {
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 * @return array   actual users capabilities
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 */
+	protected function _map_meta_caps(array $caps, string $cap, int $user_id, array $args): array
+	{
+		// only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		// okay it is a meta cap so let's first remove that cap from the $caps array.
+		if (($key = array_search($cap, $caps)) !== false) {
+			unset($caps[ $key ]);
+		}
+
+		/** @var EE_Base_Class $obj */
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		// if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = 'do_not_allow';
+			return $caps;
+		}
+		$caps[] = $cap . 's';
+		if ($obj instanceof EE_CPT_Base) {
+			// if the item author is set and the user is the author...
+			if ($obj->wp_user() && $user_id === $obj->wp_user()) {
+				// if obj is published...
+				if ($obj->status() === 'publish') {
+					$caps[] = $this->published_cap;
+				}
+			} else {
+				// the user is trying to edit someone else's obj
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+				if (! empty($this->published_cap) && $obj->status() === 'publish') {
+					$caps[] = $this->published_cap;
+				} elseif (! empty($this->private_cap) && $obj->status() === 'private') {
+					$caps[] = $this->private_cap;
+				}
+			}
+		} else {
+			// not a cpt object so handled differently
+			$has_cap = false;
+			try {
+				$has_cap = method_exists($obj, 'wp_user')
+						   && $obj->wp_user()
+						   && $obj->wp_user() === $user_id;
+			} catch (Exception $e) {
+				if (WP_DEBUG) {
+					EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+			if (! $has_cap) {
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1222,24 +1222,24 @@ 
  */
 class EE_Meta_Capability_Map_Delete extends EE_Meta_Capability_Map_Edit
 {
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     * @return array   actual users capabilities
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     */
-    protected function _map_meta_caps(array $caps, string $cap, int $user_id, array $args): array
-    {
-        return parent::_map_meta_caps($caps, $cap, $user_id, $args);
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 * @return array   actual users capabilities
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 */
+	protected function _map_meta_caps(array $caps, string $cap, int $user_id, array $args): array
+	{
+		return parent::_map_meta_caps($caps, $cap, $user_id, $args);
+	}
 }
 
 
@@ -1254,79 +1254,79 @@ 
  */
 class EE_Meta_Capability_Map_Read extends EE_Meta_Capability_Map
 {
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     * @return array   actual users capabilities
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     */
-    protected function _map_meta_caps(array $caps, string $cap, int $user_id, array $args): array
-    {
-        // only process if we're checking our mapped cap;
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        // okay it is a meta cap so let's first remove that cap from the $caps array.
-        if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[ $key ]);
-        }
-
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        // if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = 'do_not_allow';
-            return $caps;
-        }
-
-        $caps[] = $cap . 's';
-        if ($obj instanceof EE_CPT_Base) {
-            $status_obj = get_post_status_object($obj->status());
-            if ($status_obj->public) {
-                return $caps;
-            }
-            // if the item author is set and the user is not the author...
-            if ($obj->wp_user() && $obj->wp_user() !== $user_id) {
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-            }
-            // yes this means that if users created the private post, they are able to see it regardless of private cap.
-            if ($status_obj->private && ! empty($this->private_cap) && $obj->wp_user() !== $user_id) {
-                // the user is trying to view a private object for an object they don't own.
-                $caps[] = $this->private_cap;
-            }
-        } else {
-            // not a cpt object so handled differently
-            $has_cap = false;
-            try {
-                $has_cap = method_exists($obj, 'wp_user')
-                           && $obj->wp_user()
-                           && $obj->wp_user() === $user_id;
-            } catch (Exception $e) {
-                if (WP_DEBUG) {
-                    EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-            if (! $has_cap) {
-                if (! empty($this->private_cap)) {
-                    $caps[] = $this->private_cap;
-                }
-                if (! empty($this->others_cap)) {
-                    $caps[] = $this->others_cap;
-                }
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 * @return array   actual users capabilities
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 */
+	protected function _map_meta_caps(array $caps, string $cap, int $user_id, array $args): array
+	{
+		// only process if we're checking our mapped cap;
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		// okay it is a meta cap so let's first remove that cap from the $caps array.
+		if (($key = array_search($cap, $caps)) !== false) {
+			unset($caps[ $key ]);
+		}
+
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		// if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = 'do_not_allow';
+			return $caps;
+		}
+
+		$caps[] = $cap . 's';
+		if ($obj instanceof EE_CPT_Base) {
+			$status_obj = get_post_status_object($obj->status());
+			if ($status_obj->public) {
+				return $caps;
+			}
+			// if the item author is set and the user is not the author...
+			if ($obj->wp_user() && $obj->wp_user() !== $user_id) {
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+			}
+			// yes this means that if users created the private post, they are able to see it regardless of private cap.
+			if ($status_obj->private && ! empty($this->private_cap) && $obj->wp_user() !== $user_id) {
+				// the user is trying to view a private object for an object they don't own.
+				$caps[] = $this->private_cap;
+			}
+		} else {
+			// not a cpt object so handled differently
+			$has_cap = false;
+			try {
+				$has_cap = method_exists($obj, 'wp_user')
+						   && $obj->wp_user()
+						   && $obj->wp_user() === $user_id;
+			} catch (Exception $e) {
+				if (WP_DEBUG) {
+					EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+			if (! $has_cap) {
+				if (! empty($this->private_cap)) {
+					$caps[] = $this->private_cap;
+				}
+				if (! empty($this->others_cap)) {
+					$caps[] = $this->others_cap;
+				}
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1342,53 +1342,53 @@ 
  */
 class EE_Meta_Capability_Map_Messages_Cap extends EE_Meta_Capability_Map
 {
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     * @return array   actual users capabilities
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     */
-    protected function _map_meta_caps(array $caps, string $cap, int $user_id, array $args): array
-    {
-        // only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-
-        // okay it is a meta cap so let's first remove that cap from the $caps array.
-        if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[ $key ]);
-        }
-
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        // if no obj then let's just do cap
-        if (! $obj instanceof EE_Message_Template_Group) {
-            $caps[] = 'do_not_allow';
-            return $caps;
-        }
-        $caps[]    = $cap . 's';
-        $is_global = $obj->is_global();
-        if ($obj->wp_user() && $obj->wp_user() === $user_id) {
-            if ($is_global) {
-                $caps[] = $this->private_cap;
-            }
-        } else {
-            if ($is_global) {
-                $caps[] = $this->private_cap;
-            } else {
-                $caps[] = $this->others_cap;
-            }
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 * @return array   actual users capabilities
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 */
+	protected function _map_meta_caps(array $caps, string $cap, int $user_id, array $args): array
+	{
+		// only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+
+		// okay it is a meta cap so let's first remove that cap from the $caps array.
+		if (($key = array_search($cap, $caps)) !== false) {
+			unset($caps[ $key ]);
+		}
+
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		// if no obj then let's just do cap
+		if (! $obj instanceof EE_Message_Template_Group) {
+			$caps[] = 'do_not_allow';
+			return $caps;
+		}
+		$caps[]    = $cap . 's';
+		$is_global = $obj->is_global();
+		if ($obj->wp_user() && $obj->wp_user() === $user_id) {
+			if ($is_global) {
+				$caps[] = $this->private_cap;
+			}
+		} else {
+			if ($is_global) {
+				$caps[] = $this->private_cap;
+			} else {
+				$caps[] = $this->others_cap;
+			}
+		}
+		return $caps;
+	}
 }
 
 
@@ -1404,43 +1404,43 @@ 
  */
 class EE_Meta_Capability_Map_Registration_Form_Cap extends EE_Meta_Capability_Map
 {
-    /**
-     * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
-     * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
-     *
-     * @param array  $caps    actual users capabilities
-     * @param string $cap     initial capability name that is being checked (the "map" key)
-     * @param int    $user_id The user id
-     * @param array  $args    Adds context to the cap. Typically the object ID.
-     * @return array   actual users capabilities
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.5.0
-     * @see   wp-includes/capabilities.php
-     */
-    protected function _map_meta_caps(array $caps, string $cap, int $user_id, array $args): array
-    {
-        // only process if we're checking our mapped_cap
-        if ($cap !== $this->meta_cap) {
-            return $caps;
-        }
-        // okay it is a meta cap so let's first remove that cap from the $caps array.
-        if (($key = array_search($cap, $caps)) !== false) {
-            unset($caps[ $key ]);
-        }
-        $obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
-        // if no obj then let's just do cap
-        if (! $obj instanceof EE_Base_Class) {
-            $caps[] = 'do_not_allow';
-            return $caps;
-        }
-        $caps[]    = $cap . 's';
-        $is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false;
-        $is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system;
-        if ($is_system) {
-            $caps[] = $this->private_cap;
-        }
-        return $caps;
-    }
+	/**
+	 * This is the callback for the wp map_meta_caps() function which allows for ensuring certain caps that act as a
+	 * "meta" for other caps ( i.e. ee_edit_event is a meta for ee_edit_others_events ) work as expected.
+	 *
+	 * @param array  $caps    actual users capabilities
+	 * @param string $cap     initial capability name that is being checked (the "map" key)
+	 * @param int    $user_id The user id
+	 * @param array  $args    Adds context to the cap. Typically the object ID.
+	 * @return array   actual users capabilities
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 * @see   wp-includes/capabilities.php
+	 */
+	protected function _map_meta_caps(array $caps, string $cap, int $user_id, array $args): array
+	{
+		// only process if we're checking our mapped_cap
+		if ($cap !== $this->meta_cap) {
+			return $caps;
+		}
+		// okay it is a meta cap so let's first remove that cap from the $caps array.
+		if (($key = array_search($cap, $caps)) !== false) {
+			unset($caps[ $key ]);
+		}
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
+		// if no obj then let's just do cap
+		if (! $obj instanceof EE_Base_Class) {
+			$caps[] = 'do_not_allow';
+			return $caps;
+		}
+		$caps[]    = $cap . 's';
+		$is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false;
+		$is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system;
+		if ($is_system) {
+			$caps[] = $this->private_cap;
+		}
+		return $caps;
+	}
 }