Function Hook_cns_warnings_ban_member->actualise_punitive_action
Definitions
sources/hooks/systems/cns_warnings/ban_member.php
- Actualise punitive actions.Note that this assumes action was applied through the warnings form, and that post parameters still exist.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: N/A
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $punitive_messages | array | required parameter | N/A | N/A | Punitive action text to potentially be included in the PT automatically (passed by reference) |
| $warning_id | AUTO_LINK | required parameter | N/A | N/A | The ID of the warning that was created for this punitive action |
| $member_id | MEMBER | required parameter | N/A | N/A | The member this warning is being applied to |
| $username | SHORT_TEXT | required parameter | N/A | N/A | The username of the member this warning is being applied to |
| $explanation | SHORT_TEXT | required parameter | N/A | N/A | The defined explanation for this warning |
| $message | LONG_TEXT | required parameter | N/A | N/A | The message to be sent as a PT (passed by reference; you should generally use $punitive_text instead if you want to add PT text) |