Function __global->ip_banned
Definitions
sources/global3.php
- Check to see if an IP address is banned.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: bool
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $ip | string | required parameter | N/A | N/A | The IP address to check for banning |
| $force_db | boolean | False | N/A | N/A | Force check via database only |
| $handle_uncertainties | boolean | False | N/A | N/A | Handle uncertainties (used for the external bans - if true, we may return null, showing we need to do an external check). Only works with $force_db. |
| $is_unbannable | ?boolean | Null | N/A | N/A | Whether the IP is unbannable (returned by reference) (null: not set yet by caller) |
| $ban_until | ?integer | Null | N/A | N/A | When the ban will expire, will always be more than the current timestamp (null: not set yet by caller / no expiration) |
| $check_caching | boolean | True | N/A | N/A | Whether to check internal run-time caching (disable if doing automated tests) |
Return
- Whether the IP address is banned (null: unknown)
- Type: ?boolean
- Set: N/A
- Range: N/A