Function Hook_commandr_fs_root->_customise_directory
Definitions
sources/hooks/systems/commandr_fs/root.php
- Customise a directory path, adding _custom to appropriate entries.
- Visibility: protected
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: string
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $directory | array | No | No | required parameter | N/A | N/A | Path to customise |
| $change_to_override | boolean | No | No | True | N/A | N/A | Whether to rewrite to be the alternative override directory |
Returns
- Customised path
- Type: string
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Customise a directory path, adding _custom to appropriate entries.
*
* @param array $directory Path to customise
* @param boolean $change_to_override Whether to rewrite to be the alternative override directory
* @return string Customised path
*/
protected function _customise_directory(array $directory, bool $change_to_override = true) : string
* Customise a directory path, adding _custom to appropriate entries.
*
* @param array $directory Path to customise
* @param boolean $change_to_override Whether to rewrite to be the alternative override directory
* @return string Customised path
*/
protected function _customise_directory(array $directory, bool $change_to_override = true) : string
