Function __global->_build_url
Definitions
sources/urls.php
- Build and return a proper URL, from the $parameters array.Note: URL parameters should always be in lower case (one of the coding standards).
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: string
Parameters
Name | Type | Default | Set | Range | Description |
---|---|---|---|---|---|
$parameters | array | required parameter | N/A | N/A | A map of parameter names to parameter values. Values may be strings or integers, or null. null indicates "skip this". 'page' cannot be null. |
$zone_name | ID_TEXT | Blank (empty string) | N/A | N/A | The zone the URL is pointing to. YOU SHOULD NEVER HARD CODE THIS- USE '_SEARCH', '_SELF' (if you're self-referencing your own page) or the output of get_module_zone. |
$skip | array | [] | N/A | N/A | Parameters to explicitly not put in the URL (perhaps because we have $keep_all set, or we are blocking certain keep_ values). The format is of a map where the keys are the names, and the values are true. |
$keep_all | boolean | False | N/A | N/A | Whether to keep all non-skipped parameters that were in the current URL, in this URL |
$avoid_remap | boolean | False | N/A | N/A | Whether to avoid URL Schemes (sometimes essential so we can assume the standard URL parameter addition scheme in templates) |
$skip_keep | boolean | False | N/A | N/A | Whether to skip actually putting on keep_ parameters (rarely will this skipping be desirable) |
$hash | string | Blank (empty string) | N/A | N/A | Hash portion of the URL (blank: none). May or may not start '#' - code will put it on if needed |
Return
- The URL in string format
- Type: string
- Set: N/A
- Range: N/A