Function Module_galleries->show_image

Definitions

site/pages/modules/galleries.php

  • The UI to show an image.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$category_name ?string No No Null N/A N/A Alternate category name to use (null: use standard one). This is useful if you are overriding this code to show images in virtual galleries.
$breadcrumbs ?Tempcode No No Null N/A N/A Breadcrumbs (null: derive in this function)

Returns

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

Preview

Code (PHP)

/**
 * The UI to show an image.
 *
 * @param  ?string $category_name Alternate category name to use (null: use standard one). This is useful if you are overriding this code to show images in virtual galleries.
 * @param  ?Tempcode $breadcrumbs Breadcrumbs (null: derive in this function)
 * @return Tempcode The UI
 */

public function show_image(?string $category_name = null, ?object $breadcrumbs = null) : object