Function __global->process_url_monikers
Definitions
sources/site.php
- Process URL monikers, changing 'id' GET param to be correct.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: bool
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $redirect_if_non_canonical | boolean | No | No | True | N/A | N/A | Do a redirect if we're not on the canonical URL |
| $env_change | boolean | No | No | True | N/A | N/A | Change environmental $_GET parameters (otherwise returns by reference) |
| &$page | ?ID_TEXT | Yes | No | Null | N/A | N/A | The page name to do it for, as it would appear in the URL (null: read from the environment) |
| &$zone | ?ID_TEXT | Yes | No | Null | N/A | N/A | The zone name to do it for (null: read from the environment) |
| &$type | ?ID_TEXT | Yes | No | Null | N/A | N/A | The screen type to do it for (null: read from the environment / really not passed) |
| &$url_id | ?ID_TEXT | Yes | No | Null | N/A | N/A | The ID to do it for (null: read from the environment / really not passed) |
| $consider_nulls_as_unpassed | boolean | No | No | True | N/A | N/A | If any nulls are passed it's considered as 'really not passed' rather than 'read from environment' for $type and $url_id |
Returns
- Found via moniker
- Type: boolean
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Process URL monikers, changing 'id' GET param to be correct.
*
* @param boolean $redirect_if_non_canonical Do a redirect if we're not on the canonical URL
* @param boolean $env_change Change environmental $_GET parameters (otherwise returns by reference)
* @param ?ID_TEXT $page The page name to do it for, as it would appear in the URL (null: read from the environment)
* @param ?ID_TEXT $zone The zone name to do it for (null: read from the environment)
* @param ?ID_TEXT $type The screen type to do it for (null: read from the environment / really not passed)
* @param ?ID_TEXT $url_id The ID to do it for (null: read from the environment / really not passed)
* @param boolean $consider_nulls_as_unpassed If any nulls are passed it's considered as 'really not passed' rather than 'read from environment' for $type and $url_id
* @return boolean Found via moniker
*/
function process_url_monikers(bool $redirect_if_non_canonical = true, bool $env_change = true, ?string &$page = null, ?string &$zone = null, ?string &$type = null, ?string &$url_id = null, bool $consider_nulls_as_unpassed = true) : bool
* Process URL monikers, changing 'id' GET param to be correct.
*
* @param boolean $redirect_if_non_canonical Do a redirect if we're not on the canonical URL
* @param boolean $env_change Change environmental $_GET parameters (otherwise returns by reference)
* @param ?ID_TEXT $page The page name to do it for, as it would appear in the URL (null: read from the environment)
* @param ?ID_TEXT $zone The zone name to do it for (null: read from the environment)
* @param ?ID_TEXT $type The screen type to do it for (null: read from the environment / really not passed)
* @param ?ID_TEXT $url_id The ID to do it for (null: read from the environment / really not passed)
* @param boolean $consider_nulls_as_unpassed If any nulls are passed it's considered as 'really not passed' rather than 'read from environment' for $type and $url_id
* @return boolean Found via moniker
*/
function process_url_monikers(bool $redirect_if_non_canonical = true, bool $env_change = true, ?string &$page = null, ?string &$zone = null, ?string &$type = null, ?string &$url_id = null, bool $consider_nulls_as_unpassed = true) : bool