Function __global->cns_get_group_property

Definitions

sources/cns_groups.php

  • Get a certain property of a certain group.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

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

Returns

  • The property value
  • Type: mixed
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get a certain property of a certain group.
 *
 * @param  GROUP $group The ID of the group
 * @param  ID_TEXT $property The identifier of the property
 * @param  boolean $hide_hidden Whether to hide the name if it is a hidden group
 * @return mixed The property value
 */
function cns_get_group_property(int $group, string $property, bool $hide_hidden = true)