arm_is_allow_access

Home > Helpful Developer API > arm_is_allow_access

This Filter is useful to check whether the user has right to access site or not. This filter function argument and return value is true/false if the current user can/cannot access the site.

Hook Name: arm_is_allow_access
Hook Type: Filter
Source: core/classes/class.arm_restriction.php
Usage:
add_filter( 'arm_is_allow_access', 'your_function', 10, 2);
function your_function($allowed = true, $extraVars = array()) {
    //$allowed True if allowed access, False if not allowed.
    //$extraVars Array of User information like User ID & Plan ID
    if ($extraVars['current_user_id'] == 42) {
        $allowed = true;
    }
    return $allowed;
}
Parameters:
$allowed
True if allowed access, False if not allowed
$extraVars
Array of User information like User ID & Plan ID

Related Articles