Function __global->cns_get_group_members_raw_count

Definitions

sources/cns_groups2.php

  • Get a count of members in a group.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: int

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$group_id GROUP No No required parameter N/A N/A The ID of the group
$include_primaries boolean No No True N/A N/A Whether to include those in the group as a primary member
$non_validated boolean No No False N/A N/A Whether to include those applied to join the group, but not validated in
$include_secondaries boolean No No True N/A N/A Whether to include those in the group as a secondary member
$include_not_validated_members boolean No No True N/A N/A Whether to include those members who are not validated as site members at all yet (parameter currently ignored)

Returns

  • The count
  • Type: integer
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get a count of members in a group.
 *
 * @param  GROUP $group_id The ID of the group
 * @param  boolean $include_primaries Whether to include those in the group as a primary member
 * @param  boolean $non_validated Whether to include those applied to join the group, but not validated in
 * @param  boolean $include_secondaries Whether to include those in the group as a secondary member
 * @param  boolean $include_not_validated_members Whether to include those members who are not validated as site members at all yet (parameter currently ignored)
 * @return integer The count
 */
function cns_get_group_members_raw_count(int $group_id, bool $include_primaries = true, bool $non_validated = false, bool $include_secondaries = true, bool $include_not_validated_members = true) : int