Function __global->cns_get_group_link

Definitions

sources/cns_groups.php

  • Get a rendered link to a usergroup.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$id GROUP No No required parameter N/A N/A The ID of the group
$hide_hidden boolean No No True N/A N/A Whether to hide the name if it is a hidden group

Returns

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

Preview

Code (PHP)

/**
 * Get a rendered link to a usergroup.
 *
 * @param  GROUP $id The ID of the group
 * @param  boolean $hide_hidden Whether to hide the name if it is a hidden group
 * @return Tempcode The link
 */
function cns_get_group_link(int $id, bool $hide_hidden = true) : object