API17

JUserHelper::addUserToGroup: Difference between revisions

From Joomla! Documentation

Doxiki2 (talk | contribs)
Layout updates
Doxiki2 (talk | contribs)
Updated to r1448:247ba8d88526
Line 8: Line 8:
<nowiki>[</nowiki>[[Description:JUserHelper::addUserToGroup|Edit Descripton]]<nowiki>]</nowiki>
<nowiki>[</nowiki>[[Description:JUserHelper::addUserToGroup|Edit Descripton]]<nowiki>]</nowiki>
</span>
</span>
===Since===
{{JVer|11.1 }}
===Synopsis===
<source lang="php">
<source lang="php">
public static JUserHelper::addUserToGroup ($userId, $groupId)
public static function addUserToGroup (
        $userId
        $groupId
)
</source>
</source>
{| class="wikitable"
{| class="wikitable"
Line 29: Line 29:
|integer
|integer
|
|
|The id of the group.  
|The id of the group.
|-
|-
|}
|}
===Returns===
* '''Returns''' mixed Boolean true on success,  on error.
mixed Boolean true on success,  on error.
* '''Defined''' on line 35 of libraries/joomla/user/helper.php
===Defined in===
* '''Since''' {{JVer|11.1 }}
libraries/joomla/user/helper.php (line 34)
* see source code in [[jplatform:user/helper.php#cl-34|BitBucket]]
===Referenced by===
===See also===
===See also===
* {{JVer|11.1}} '''JUserHelper::addUserToGroup source code''' on [[jplatform:user/helper.php#cl-27|BitBucket]]
* {{JVer|11.1}} Class [[JUserHelper/11.1|JUserHelper]]
* {{JVer|11.1}} Subpackage [[Subpackage_User/11.1|User]]
* [[JUserHelper::addUserToGroup|Other versions of JUserHelper::addUserToGroup]]
{{SeeAlso:JUserHelper::addUserToGroup}}
<span class="editsection" style="font-size:76%;">
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[SeeAlso:JUserHelper::addUserToGroup|Edit See Also]]<nowiki>]</nowiki>
<nowiki>[</nowiki>[[SeeAlso:JUserHelper::addUserToGroup|Edit See Also]]<nowiki>]</nowiki>
</span>
</span>
* [[JUserHelper/11.1|JUserHelper]]
===User contributed notes===
* [[JUserHelper::addUserToGroup|Other versions of this method]]
{{SeeAlso:JUserHelper::addUserToGroup}}
===Examples===
<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::addUserToGroup]]</noinclude>
<noinclude>[[Category:JUserHelper]][[Category:JUserHelper::addUserToGroup]]</noinclude>

Revision as of 02:55, 28 April 2011

Joomla 11.1 JUserHelper::addUserToGroup

Description

Method to add a user to a group.

Template:Description:JUserHelper::addUserToGroup [Edit Descripton]

public static function addUserToGroup (
        $userId
        $groupId
)
Parameter Type Default Description
$userId integer The id of the user.
$groupId integer The id of the group.
  • Returns mixed Boolean true on success, on error.
  • Defined on line 35 of libraries/joomla/user/helper.php
  • Since Joomla 11.1

See also

Template:SeeAlso:JUserHelper::addUserToGroup [Edit See Also]

User contributed notes

<CodeExamplesForm />