禁止用户

Shield 提供了一种方法，可禁止用户使用你的应用程序。如果你需要阻止用户登录，或者在他们违反服务条款时将其注销，这将非常有用。

注意

在使用以下方法之前，你需要获取 User 实体。有关详细信息，请参阅 获取当前用户 或 查找用户。

检查用户是否被禁止

你可以使用 User 实体上的 isBanned() 方法检查用户是否被禁止。该方法返回布尔值 true/false。

if ($user->isBanned()) {
    //...
}

禁止用户

要禁止用户使用应用程序，可以对 User 实体调用 ban(?string $message = null) 方法。该方法采用一个可选字符串作为参数。该字符串充当禁止的原因。

// banning a user without passing a message
$user->ban();
// banning a user with a message and reason for the ban passed.
$user->ban('Your reason for banning the user here');

取消禁止用户

可以使用 User 实体上的 unBan() 方法取消禁止用户。此方法还将重置 status_message 属性。

$user->unBan();

获取禁止原因

可以使用 User 实体上的 getBanMessage() 方法获取禁止原因。

$user->getBanMessage();