Function Module_groups->display_group_link

Definitions

site/pages/modules/groups.php

  • Display a link to a group from the directory.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$row array No No required parameter N/A N/A The group row
$include_club_labelling boolean No No True N/A N/A Include special labelling for clubs

Returns

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

Preview

Code (PHP)

/**
 * Display a link to a group from the directory.
 *
 * @param  array $row The group row
 * @param  boolean $include_club_labelling Include special labelling for clubs
 * @return Tempcode The link
 */
protected function display_group_link(array $row, bool $include_club_labelling = true) : object