Joomla! Documentation™

The "API16" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description

Get a group ID from a given name

<! removed transcluded page call, red link never existed >

Syntax

getGroupIDFromName($groupname)

Parameter Name	Default Value	Description
$groupname		Name of group to find

Returns

int the group id of the user, false on error

Defined in

libraries/joomla/installer/installer.php

Importing

jimport( 'joomla.installer.installer' );

Source Body

function getGroupIDFromName($groupname)
{
        $dbo = $this->getDBO();
        $dbo->setQuery('SELECT id FROM #__usergroups WHERE title = "'. $dbo->getEscaped($groupname) .'"');
        return $dbo->loadResult();
}

<! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />