Moderation
ban
$ban
Bans a user from the Discord server.
Syntax
$ban[userID;(reason);(deleteMessagesDays)]
$ban
The $ban function bans a user from the Discord server. The bot must have the BanMembers permission.
Syntax
$ban[userID;(reason);(deleteMessagesDays)]
Parameters
| Parameter | Description |
|---|---|
userID |
The ID of the user to ban. Required. |
reason |
Optional. The ban reason. |
deleteMessagesDays |
Optional. Number of days (0-7) of messages to delete. Default 0. |
Return value
None. The function bans the user and deletes their messages if requested.
Examples
Simple ban with mention
$ban[$mentioned[1];Spam]
$sendMessage[<@$mentioned[1]> has been banned for spam.]
Ban with message deletion
$ban[$findUser[JohnDoe];Harassment;7]
$sendMessage[JohnDoe banned — 7 days of messages deleted.]
Ban command with confirmation
$if[$argsCount<1]
$sendMessage[Usage: !ban <@mention> <reason>]
$stop
$endif
$ban[$mentioned[1];$replaceText[$message;-;$mentioned[1];]]
$sendMessage[✅ <@$mentioned[1]> banned.]
Notes
- The bot must have the
BanMemberspermission. deleteMessagesDaysaccepts a value between0and7.- The bot cannot ban a user with a role higher than its own.
- To ban by ID without mention, use
$banID.