API17

Difference between revisions of "JUserHelper::addUserToGroup"

From Joomla! Documentation

(Layout updates)
m (preparing for archive only)
 
(5 intermediate revisions by 2 users not shown)
Line 4: Line 4:
 
Method to add a user to a group.  
 
Method to add a user to a group.  
  
{{Description:JUserHelper::addUserToGroup}}
+
 
<span class="editsection" style="font-size:76%;">
+
 
<nowiki>[</nowiki>[[Description:JUserHelper::addUserToGroup|Edit Descripton]]<nowiki>]</nowiki>
 
</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 27:
 
|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===
<span class="editsection" style="font-size:76%;">
+
* {{JVer|11.1}} '''JUserHelper::addUserToGroup source code''' on [[jplatform:user/helper.php#cl-27|BitBucket]]
<nowiki>[</nowiki>[[SeeAlso:JUserHelper::addUserToGroup|Edit See Also]]<nowiki>]</nowiki>
+
* {{JVer|11.1}} Class [[API17:JUserHelper|JUserHelper]]
</span>
+
* {{JVer|11.1}} Subpackage [[API17:Subpackage_User|User]]
* [[JUserHelper/11.1|JUserHelper]]
+
* [[API17:JUserHelper::addUserToGroup|Other versions of JUserHelper::addUserToGroup]]
* [[JUserHelper::addUserToGroup|Other versions of this method]]
+
 
{{SeeAlso:JUserHelper::addUserToGroup}}
+
 
===Examples===
+
===User contributed notes===
<CodeExamplesForm />
+
=== Code Examples ===
 
<dpl>
 
<dpl>
 
noresultsheader=\n
 
noresultsheader=\n
 
category=JUserHelper::addUserToGroup
 
category=JUserHelper::addUserToGroup
category=CodeExample
+
namespace=CodeExample
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
<noinclude>[[Category:JUserHelper]][[Category:JUserHelper::addUserToGroup]]</noinclude>
+
<noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude>

Latest revision as of 21:55, 24 March 2017

The "API17" 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.

Joomla 11.1 JUserHelper::addUserToGroup[edit]

Description[edit]

Method to add a user to a group.


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[edit]


User contributed notes[edit]

Code Examples[edit]