Function __global->add_ip_ban
Definitions
sources/failure.php
- Add an IP-ban.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: bool
Parameters
Name | Type | Default | Set | Range | Description |
---|---|---|---|---|---|
$ip | IP | required parameter | N/A | N/A | The IP address to ban (potentially encoded with *'s) |
$descrip | LONG_TEXT | Blank (empty string) | N/A | N/A | Explanation for ban |
$ban_until | ?TIME | Null | N/A | N/A | When to ban until (null: no limit) |
$ban_positive | boolean | True | N/A | N/A | Whether this is a positive ban (as opposed to a cached negative) |
$check_caching | boolean | True | N/A | N/A | Whether to check internal run-time caching (disable if doing automated tests) |
Return
- Whether a change actually happened
- Type: boolean
- Set: N/A
- Range: N/A