deleteMembergroups

Description

Deletes one or more membergroups.

Syntax

bool deleteMembergroups (mixed $groups)


Parameter $groups

Expected type: Mixed
Description: Which group(s) to delete

Allowed types for $groups
Allowed values Description
Integer The ID of a single group
Array of Integers The IDs of one or more groups


Return value

Expected type: Boolean
Description: Whether or not all specified groups were successfully deleted


Notes

  • Requires the manage_membergroups permission.
  • Returns true on success or false on failure.
  • Has protection against deletion of protected membergroups (Unregistered Guests, Regular Members, Administrator, Moderator and Newbie)
  • Deletes the permissions linked to the membergroup.
  • Takes members out of the deleted membergroups.
View all versions of this function
Advertisement: