Function __global->cns_member_leave_secondary_group

Definitions

sources/cns_groups_action2.php

  • Remove a usergroup from a member's secondary usergroup memberships. Be sure to call cns_update_group_approvals at some point after this.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$group_id GROUP No No required parameter N/A N/A The usergroup to remove from
$member_id ?MEMBER No No Null N/A N/A The member leaving (null: current member)

Preview

Code (PHP)

/**
 * Remove a usergroup from a member's secondary usergroup memberships. Be sure to call cns_update_group_approvals at some point after this.
 *
 * @param  GROUP $group_id The usergroup to remove from
 * @param  ?MEMBER $member_id The member leaving (null: current member)
 */
function cns_member_leave_secondary_group(int $group_id, ?int $member_id = null)