API17:JUserHelper::setUserGroups
From Joomla! Documentation
(Difference between revisions)
(Layout updates) |
(Updated to r1448:247ba8d88526) |
||
| Line 8: | Line 8: | ||
<nowiki>[</nowiki>[[Description:JUserHelper::setUserGroups|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JUserHelper::setUserGroups|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
<source lang="php"> | <source lang="php"> | ||
| − | public static | + | public static function setUserGroups ( |
| + | $userId | ||
| + | $groups | ||
| + | ) | ||
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 29: | Line 29: | ||
|array | |array | ||
| | | | ||
| − | |An array of group ids to put the user in. | + | |An array of group ids to put the user in. |
|- | |- | ||
|} | |} | ||
| − | + | * '''Returns''' mixed Boolean true on success, on error. | |
| − | mixed Boolean true on success, on error. | + | * '''Defined''' on line 146 of libraries/joomla/user/helper.php |
| − | + | * '''Since''' {{JVer|11.1 }} | |
| − | libraries/joomla/user/helper.php | + | |
| − | * | + | |
| − | + | ||
===See also=== | ===See also=== | ||
| + | * {{JVer|11.1}} '''JUserHelper::setUserGroups source code''' on [[jplatform:user/helper.php#cl-138|BitBucket]] | ||
| + | * {{JVer|11.1}} Class [[JUserHelper/11.1|JUserHelper]] | ||
| + | * {{JVer|11.1}} Subpackage [[Subpackage_User/11.1|User]] | ||
| + | * [[JUserHelper::setUserGroups|Other versions of JUserHelper::setUserGroups]] | ||
| + | {{SeeAlso:JUserHelper::setUserGroups}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JUserHelper::setUserGroups|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JUserHelper::setUserGroups|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | + | ===User contributed notes=== | |
| − | + | ||
| − | + | ||
| − | === | + | |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 53: | Line 52: | ||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:JUserHelper]][[Category:JUserHelper::setUserGroups]]</noinclude> | <noinclude>[[Category:JUserHelper]][[Category:JUserHelper::setUserGroups]]</noinclude> | ||
Revision as of 21:55, 27 April 2011
JUserHelper::setUserGroups
Description
Method to set the groups for a user.
Description:JUserHelper::setUserGroups [Edit Descripton]
public static function setUserGroups ( $userId $groups )
| Parameter | Type | Default | Description |
|---|---|---|---|
| $userId | integer | The id of the user. | |
| $groups | array | An array of group ids to put the user in. |
- Returns mixed Boolean true on success, on error.
- Defined on line 146 of libraries/joomla/user/helper.php
- Since
See also
- JUserHelper::setUserGroups source code on BitBucket
- Class JUserHelper
- Subpackage User
- Other versions of JUserHelper::setUserGroups
SeeAlso:JUserHelper::setUserGroups [Edit See Also]
User contributed notes
<CodeExamplesForm />
