Function __global->render_gallery_box

Definitions

sources/galleries.php

  • Get preview detailing for a gallery.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$myrow array No No required parameter N/A N/A The database row of the gallery
$root ID_TEXT No No root N/A N/A The virtual root of the gallery
$show_member_stats_if_appropriate boolean No No False N/A N/A Whether to show member stats if it is a member owned gallery
$zone ID_TEXT No No _SEARCH N/A N/A The zone that the gallery module we are linking to is in
$quit_if_empty boolean No No True N/A N/A Whether to not show anything if the gallery is empty
$preview boolean No No False N/A N/A Whether only to show 'preview' details
$give_context boolean No No True N/A N/A Whether to include context (i.e. say WHAT this is, not just show the actual content)
$include_breadcrumbs boolean No No True N/A N/A Whether to include breadcrumbs (if there are any)
$attach_to_url_filter boolean No No False N/A N/A Whether to copy through any filter parameters in the URL, under the basis that they are associated with what this box is browsing
$guid ID_TEXT No No Blank (empty string) N/A N/A Overridden GUID to send to templates (blank: none)

Returns

  • The preview
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get preview detailing for a gallery.
 *
 * @param  array $myrow The database row of the gallery
 * @param  ID_TEXT $root The virtual root of the gallery
 * @param  boolean $show_member_stats_if_appropriate Whether to show member stats if it is a member owned gallery
 * @param  ID_TEXT $zone The zone that the gallery module we are linking to is in
 * @param  boolean $quit_if_empty Whether to not show anything if the gallery is empty
 * @param  boolean $preview Whether only to show 'preview' details
 * @param  boolean $give_context Whether to include context (i.e. say WHAT this is, not just show the actual content)
 * @param  boolean $include_breadcrumbs Whether to include breadcrumbs (if there are any)
 * @param  boolean $attach_to_url_filter Whether to copy through any filter parameters in the URL, under the basis that they are associated with what this box is browsing
 * @param  ID_TEXT $guid Overridden GUID to send to templates (blank: none)
 * @return Tempcode The preview
 */
function render_gallery_box(array $myrow, string $root = 'root', bool $show_member_stats_if_appropriate = false, string $zone = '_SEARCH', bool $quit_if_empty = true, bool $preview = false, bool $give_context = true, bool $include_breadcrumbs = true, bool $attach_to_url_filter = false, string $guid = '') : object