API17

Difference between revisions of "JUserHelper::removeUserFromGroup"

From Joomla! Documentation

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

Revision as of 21:55, 27 April 2011

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

Description[edit]

Method to remove a user from a group.

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

public static function removeUserFromGroup (
        $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 107 of libraries/joomla/user/helper.php
  • Since Joomla 11.1

See also[edit]

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

User contributed notes[edit]

<CodeExamplesForm />