# m_ban_user
# Function
| Function Name | Description | Level |
|---|---|---|
| m_ban_user | Ability to ban a particular user. |
Input Parameters:
| Name | Type | Required? | Description | Level |
|---|---|---|---|---|
| user_name | byte[] | yes | ||
| mode | Int | yes | "1" = ban the user. "2" = ban the user and delete all his posts (soft-delete if soft-delete is supported by the forum system. | |
| reason_text | byte[] | This option allows user to insert the reason of deletion. | ||
| expires | Int | Expire timestamps. need flag 'ban_expires' in get_config to support this parameter |
Output Parameters:
| Name | Type | Required? | Description | Level |
|---|---|---|---|---|
| result | Boolean | yes | return true if the action is executed successfully. | |
| result_text | byte[] | Reason of the failure, if any. | ||
| is_login_mod | Boolean | return true if user need to re-authenticate with login_mod function again before proceeding. |