Moderation
getBanReason
$getBanReason
Gets the ban reason of a banned user on the server. Returns the reason stored in the server's ban list.
Syntax
$getBanReason[userID]
$getBanReason
The $getBanReason[] function allows you to retrieve the ban reason of a banned user on the current server.
Syntax
$getBanReason[userID]
Parameters
| Parameter | Description |
|---|---|
userID |
The ID of the banned user. |
Return Value
- Type: String
- The ban reason as registered by Discord.
- An empty string if the user is not banned or if no reason was specified.
Behavior
- The bot must have the
BAN_MEMBERSpermission to view ban reasons. - The reason returned is the one provided during the ban (via
$ban[userID;reason]). - If the user is not banned, it returns an empty string.
Examples
Ban verification
$let[reason;$getBanReason[$mentioned[1]]]
$if[$reason!=]
$title[🔨 Banned User]
$description[
**User:** $userName[$mentioned[1]]
**ID:** $mentioned[1]
**Reason:** $reason
]
$color[#ED4245]
$sendMessage[]
$else
$sendMessage[This user is not banned.]
$endif
Ban log
$let[reason;$getBanReason[$userID]]
$title[📋 Ban Details]
$description[
**User:** $userName[$userID] ($userID)
**Ban Reason:** $reason
**Checked on:** $date[$day]/$date[$month]/$date[$year]
]
$color[#5865F2]
$sendMessage[]
Verification command
$if[$checkContains[$userPerms;BanMembers]==true]
$let[target;$findUser[$message]]
$if[$target!=]
$let[reason;$getBanReason[$target]]
$if[$reason!=]
$sendMessage[**$userName[$target]** is banned. Reason: $reason]
$else
$sendMessage[**$userName[$target]** is not banned.]
$endif
$else
$sendMessage[User not found.]
$endif
$else
$sendMessage[Permission denied.]
$endif
Notes
- The reason is stored by Discord and is persistent.
- Useful for moderation logs and transparency.
- Only users with
BAN_MEMBERScan view the reasons. - Only works on the current server.