Function __global->get_param_wiki_chain
Definitions
sources/wiki.php
- Get a chain script parameter or just an ID, in which case it does more work), and converts it into a ID/chain pair.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $parameter_name | ID_TEXT | No | No | required parameter | N/A | N/A | The name of the GET parameter that stores the chain |
| $default_value | ?string | No | No | Null | N/A | N/A | The default value for the chain (null: no default) |
Returns
- An array of two elements: an ID and a chain
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get a chain script parameter or just an ID, in which case it does more work), and converts it into a ID/chain pair.
*
* @param ID_TEXT $parameter_name The name of the GET parameter that stores the chain
* @param ?string $default_value The default value for the chain (null: no default)
* @return array An array of two elements: an ID and a chain
*/
function get_param_wiki_chain(string $parameter_name, ?string $default_value = null) : array
* Get a chain script parameter or just an ID, in which case it does more work), and converts it into a ID/chain pair.
*
* @param ID_TEXT $parameter_name The name of the GET parameter that stores the chain
* @param ?string $default_value The default value for the chain (null: no default)
* @return array An array of two elements: an ID and a chain
*/
function get_param_wiki_chain(string $parameter_name, ?string $default_value = null) : array
