UserGroups ​
- Type
- Class
- Namespace
- craft\mcp\capabilities
- Inherits
- craft\mcp\capabilities\UserGroups
- Since
- 5.12.0
Public Methods ​
| Method | Description |
|---|---|
| __construct() | |
| create() | |
| delete() | |
| get() | |
| list() | |
| resource() | |
| resourceByIdentifier() | |
| update() |
__construct() ​
Arguments ​
$userGroups
create() ​
Arguments ​
$name$handle$description
Returns ​
array{group: array<string,mixed>}
delete() ​
Arguments ​
$id$uid$handle
Returns ​
array{deleted: true}
get() ​
Arguments ​
$id$uid$handle
Returns ​
array{group: array<string,mixed>}
list() ​
Returns ​
array{count: int, groups: list<array<string,mixed>>}
resource() ​
Returns ​
array{count: int, groups: list<array<string,mixed>>}
resourceByIdentifier() ​
Arguments ​
$group
Returns ​
array{group: array<string,mixed>}
update() ​
Arguments ​
$context$id$uid$currentHandle(string, null) – Existing user group handle.$name$handle$description
Returns ​
array{group: array<string,mixed>}