Back to User class

Method groups

public static array
groups
(mixed $includeSuperAdmin = false)
Displays a list of user groups.
Parameters
  • bool $includeSuperAdmin true to include super admin groups, false to exclude them
Returns
  • array An array containing a list of user groups.
Since
  • 2.5
Class: User
Project: Joomla

Method groups - Source code

/**
 * Displays a list of user groups.
 *
 * @param   boolean  $includeSuperAdmin  true to include super admin groups, false to exclude them
 *
 * @return  array  An array containing a list of user groups.
 *
 * @since   2.5
 */
public static function groups($includeSuperAdmin = false)
{
    $options = array_values(UserGroupsHelper::getInstance()->getAll());
    for ($i = 0, $n = count($options); $i < $n; $i++) {
        $options[$i]->value = $options[$i]->id;
        $options[$i]->text = str_repeat('- ', $options[$i]->level) . $options[$i]->title;
        $groups[] = HTMLHelper::_('select.option', $options[$i]->value, $options[$i]->text);
    }
    // Exclude super admin groups if requested
    if (!$includeSuperAdmin) {
        $filteredGroups = array();
        foreach ($groups as $group) {
            if (!Access::checkGroup($group->value, 'core.admin')) {
                $filteredGroups[] = $group;
            }
        }
        $groups = $filteredGroups;
    }
    return $groups;
}