Function __global->get_group_colour

Definitions

sources/cns_general.php

  • Get a usergroup colour based on its ID number.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$gid GROUP No No required parameter N/A N/A ID number

Returns

  • Colour
  • Type: string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get a usergroup colour based on its ID number.
 *
 * @param  GROUP $gid ID number
 * @return string Colour
 */
function get_group_colour(int $gid) : string