Function __global->cns_delete_group

Definitions

sources/cns_groups_action2.php

  • Delete a usergroup.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$group_id AUTO_LINK No No required parameter N/A N/A The ID of the usergroup to delete
$target_group ?GROUP No No Null N/A N/A The usergroup to move primary members to (null: main members)

Preview

Code (PHP)

/**
 * Delete a usergroup.
 *
 * @param  AUTO_LINK $group_id The ID of the usergroup to delete
 * @param  ?GROUP $target_group The usergroup to move primary members to (null: main members)
 */

function cns_delete_group(int $group_id, ?int $target_group = null)