Function __global->find_all_zones
Definitions
sources/zones.php
- Find the installed zones, up to the first $max installed.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $search | boolean | No | No | False | N/A | N/A | Whether to search the file system and return zones that might not be fully in the system (otherwise will just use the database) |
| $get_titles | boolean | No | No | False | N/A | N/A | Whether to get titles for the zones as well. Only if !$search |
| $force_all | boolean | No | No | False | N/A | N/A | Whether to insist on getting all zones without $start/$max parameters (there could be thousands in theory...) |
| $start | integer | No | No | 0 | N/A | N/A | Start position to get results from (ignored if $force_all is on) |
| $max | integer | No | No | 50 | N/A | N/A | Maximum zones to get |
Returns
- A list of zone names / a list of quartets (name, title, default page, zone row)
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Find the installed zones, up to the first $max installed.
*
* @param boolean $search Whether to search the file system and return zones that might not be fully in the system (otherwise will just use the database)
* @param boolean $get_titles Whether to get titles for the zones as well. Only if !$search
* @param boolean $force_all Whether to insist on getting all zones without $start/$max parameters (there could be thousands in theory...)
* @param integer $start Start position to get results from (ignored if $force_all is on)
* @param integer $max Maximum zones to get
* @return array A list of zone names / a list of quartets (name, title, default page, zone row)
*/
function find_all_zones(bool $search = false, bool $get_titles = false, bool $force_all = false, int $start = 0, int $max = 50) : array
* Find the installed zones, up to the first $max installed.
*
* @param boolean $search Whether to search the file system and return zones that might not be fully in the system (otherwise will just use the database)
* @param boolean $get_titles Whether to get titles for the zones as well. Only if !$search
* @param boolean $force_all Whether to insist on getting all zones without $start/$max parameters (there could be thousands in theory...)
* @param integer $start Start position to get results from (ignored if $force_all is on)
* @param integer $max Maximum zones to get
* @return array A list of zone names / a list of quartets (name, title, default page, zone row)
*/
function find_all_zones(bool $search = false, bool $get_titles = false, bool $force_all = false, int $start = 0, int $max = 50) : array
