Function __global->create_selection_list_gallery_tree

Definitions

sources/galleries.php

  • Get a nice, formatted, HTML list of the galleries, extending deeper from the given gallery, showing all sub(sub...)galleries.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$it ?ID_TEXT No No Null N/A N/A The gallery to select by default (null: no specific default)
$filter ?string No No Null N/A N/A A function name to filter galleries with (null: no filter)
$must_accept_images boolean No No False N/A N/A Whether displayed galleries must support images
$must_accept_videos boolean No No False N/A N/A Whether displayed galleries must support videos
$purity boolean No No False N/A N/A Whether to NOT show member galleries that do not exist yet
$use_compound_list boolean No No False N/A N/A Whether to get a list of child galleries (not just direct ones, recursively), instead of just IDs
$member_id ?MEMBER No No Null N/A N/A Member we are filtering for (null: not needed)
$addable_filter boolean No No False N/A N/A Whether to only show for what may be added to by the current member
$editable_filter boolean No No False N/A N/A Whether to only show for what may be edited by the current member
$updated_since ?TIME No No Null N/A N/A Time from which content must be updated (null: no limit)

Returns

  • The tree list
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get a nice, formatted, HTML list of the galleries, extending deeper from the given gallery, showing all sub(sub...)galleries.
 *
 * @param  ?ID_TEXT $it The gallery to select by default (null: no specific default)
 * @param  ?string $filter A function name to filter galleries with (null: no filter)
 * @param  boolean $must_accept_images Whether displayed galleries must support images
 * @param  boolean $must_accept_videos Whether displayed galleries must support videos
 * @param  boolean $purity Whether to NOT show member galleries that do not exist yet
 * @param  boolean $use_compound_list Whether to get a list of child galleries (not just direct ones, recursively), instead of just IDs
 * @param  ?MEMBER $member_id Member we are filtering for (null: not needed)
 * @param  boolean $addable_filter Whether to only show for what may be added to by the current member
 * @param  boolean $editable_filter Whether to only show for what may be edited by the current member
 * @param  ?TIME $updated_since Time from which content must be updated (null: no limit)
 * @return Tempcode The tree list
 */
function create_selection_list_gallery_tree(?string $it = null, ?string $filter = null, bool $must_accept_images = false, bool $must_accept_videos = false, bool $purity = false, bool $use_compound_list = false, ?int $member_id = null, bool $addable_filter = false, bool $editable_filter = false, ?int $updated_since = null) : object