Function __global->cns_edit_warning
Definitions
sources/cns_warnings2.php
- Edit a formal warning.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: int
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $warning_id | AUTO_LINK | No | No | required parameter | N/A | N/A | The ID of the formal warning we are editing |
| $explanation | LONG_TEXT | No | No | required parameter | N/A | N/A | An explanation for why the member is being warned |
| $is_warning | BINARY | No | No | 1 | N/A | N/A | Whether this counts as a warning |
Returns
- The member ID the warning was for
- Type: AUTO_LINK
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Edit a formal warning.
*
* @param AUTO_LINK $warning_id The ID of the formal warning we are editing
* @param LONG_TEXT $explanation An explanation for why the member is being warned
* @param BINARY $is_warning Whether this counts as a warning
* @return AUTO_LINK The member ID the warning was for
*/
function cns_edit_warning(int $warning_id, string $explanation, int $is_warning = 1) : int
* Edit a formal warning.
*
* @param AUTO_LINK $warning_id The ID of the formal warning we are editing
* @param LONG_TEXT $explanation An explanation for why the member is being warned
* @param BINARY $is_warning Whether this counts as a warning
* @return AUTO_LINK The member ID the warning was for
*/
function cns_edit_warning(int $warning_id, string $explanation, int $is_warning = 1) : int
