Function Hook_commandr_fs_catalogues->folder_add
Definitions
sources/hooks/systems/commandr_fs/catalogues.php
- Standard Commandr-fs add function for resource-fs hooks. Adds some resource with the given label and properties.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: N/A
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $filename | LONG_TEXT | required parameter | N/A | N/A | Filename OR Resource label |
| $path | string | required parameter | N/A | N/A | The path (blank: root / not applicable) |
| $properties | array | required parameter | N/A | N/A | Properties (may be empty, properties given are open to interpretation by the hook but generally correspond to database fields) |
| $force_type | ?ID_TEXT | Null | N/A | N/A | Resource type to try to force (null: do not force) |
Return
- The resource ID (false: error)
- Type: ~ID_TEXT
- Set: N/A
- Range: N/A