Entity Info
userName
$userName
The $userName function returns the global Discord username of the user who triggered the command.
Syntax
$userName[(userID)]
Parameters
| Parameter | Description |
|---|---|
userID |
Optional. The numeric ID of the user to look up. Without it, the user who triggered the command is used. A value that is not a valid ID is an error (“Invalid user ID.”), and an unknown user is an error (“User not found.”). |
Return Value
- Type: String
- The global Discord username (e.g., “JeanDupont”)
Behavior
- Returns the global username (the one visible everywhere on Discord, without the discriminator).
- If the user has a nickname on the server,
$userNamestill returns their global username. Use$nicknamefor the server nickname, or$displayNamefor the display name.
Examples
Welcome message
$title[Welcome $userName!]
$description[We are delighted to welcome you to the server 🎉]
$color[#57F287]
Create a custom embed
$author[$userName;$authorAvatar]
$title[User Profile]
$description[
**Name:** $userName
**ID:** $userID
**Tag:** $userTag
]
$color[#5865F2]
Notes
- The username is set by the user and can be modified at any time.
- Maximum length: 32 characters.
- For reliable identification, use
$userIDrather than$userName. - Do not confuse with
$nickname(server-specific nickname) and$displayName(the best of both).
Try it
Paste an example into the playground to preview its message (functions that act on Discord are not run), or build the same thing with blocks.