Function __global->get_gallery_tree
Definitions
sources/galleries.php
- Get a list of maps containing all the subcategories, and path information, of the specified gallery - and those beneath it, recursively.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $gallery | ?ID_TEXT | root | N/A | N/A | The gallery we are getting the tree starting from (null: root) |
| $breadcrumbs | string | Blank (empty string) | N/A | N/A | The parent breadcrumbs at this point of the recursion |
| $gallery_info | ?array | Null | N/A | N/A | The database row for the $gallery gallery (null: get it from the DB) |
| $do_stats | boolean | False | N/A | N/A | Whether to include video/image statistics in the returned tree |
| $filter | ?string | Null | N/A | N/A | A function name to filter galleries with OR a Selectcode string (null: no filter) |
| $must_accept_images | boolean | False | N/A | N/A | Whether displayed galleries must support images |
| $must_accept_videos | boolean | False | N/A | N/A | Whether displayed galleries must support videos |
| $purity | boolean | False | N/A | N/A | Whether to NOT show member galleries that do not exist yet |
| $use_compound_list | boolean | False | N/A | N/A | Whether to get a list of child galleries (not just direct ones, recursively), instead of just IDs |
| $levels | ?integer | Null | N/A | N/A | The number of recursive levels to search (null: all) |
| $member_id | ?MEMBER | Null | N/A | N/A | Member we are filtering for (null: not needed) |
| $addable_filter | boolean | False | N/A | N/A | Whether to only show for what may be added to by the current member |
| $editable_filter | boolean | False | N/A | N/A | Whether to only show for what may be edited by the current member |
Return
- A list of maps for all subcategories, contains more details if stats were requested
- Type: array
- Set: N/A
- Range: N/A