Elgg\Database\UsersTable::ban PHP Method

ban() public method

Ban a user (calls events, stores the reason)
public ban ( integer $user_guid, string $reason = "" ) : boolean
$user_guid integer The user guid
$reason string A reason
return boolean
    public function ban($user_guid, $reason = "")
    {
        $user = get_entity($user_guid);
        if (!$user instanceof ElggUser || !$user->canEdit()) {
            return false;
        }
        if (!$this->events->trigger('ban', 'user', $user)) {
            return false;
        }
        create_metadata($user_guid, 'ban_reason', $reason, '', 0, ACCESS_PUBLIC);
        _elgg_invalidate_cache_for_entity($user_guid);
        _elgg_invalidate_memcache_for_entity($user_guid);
        if ($this->markBanned($user_guid, true)) {
            return true;
        }
        return false;
    }