JUserHelper::removeUserFromGroup: Difference between revisions
From Joomla! Documentation
Bulk upload by Doxiki2 |
m preparing for archive only |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 4: | Line 4: | ||
Method to remove a user from a group. | Method to remove a user from a group. | ||
<source lang="php"> | <source lang="php"> | ||
public static | public static function removeUserFromGroup ( | ||
$userId | |||
$groupId | |||
) | |||
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 32: | Line 30: | ||
|- | |- | ||
|} | |} | ||
* '''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 | ||
* '''Since''' {{JVer|11.1 }} | |||
libraries/joomla/user/helper.php | |||
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JUserHelper::removeUserFromGroup source code''' on [[jplatform:user/helper.php#cl-99|BitBucket]] | |||
* {{JVer|11.1}} Class [[API17:JUserHelper|JUserHelper]] | |||
* {{JVer|11.1}} Subpackage [[API17:Subpackage_User|User]] | |||
* | * [[API17:JUserHelper::removeUserFromGroup|Other versions of JUserHelper::removeUserFromGroup]] | ||
* [[JUserHelper::removeUserFromGroup|Other versions of | |||
===Examples=== | ===User contributed notes=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JUserHelper::removeUserFromGroup | category=JUserHelper::removeUserFromGroup | ||
namespace=CodeExample | |||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
namespace=CodeExample | |||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category: | <noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude> | ||
Latest revision as of 03:56, 25 March 2017
JUserHelper::removeUserFromGroup
Description
Method to remove a user from a group.
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
See also
- JUserHelper::removeUserFromGroup source code on BitBucket
- Class JUserHelper
- Subpackage User
- Other versions of JUserHelper::removeUserFromGroup
User contributed notes
Code Examples