CategoryGroups ​
- Type
- Class
- Namespace
- craft\web\twig\variables
- Inherits
- craft\web\twig\variables\CategoryGroups
- Since
- 3.0.0
- Deprecated in
- in 3.0.0
Class CategoryGroupsVariable
Public Methods ​
| Method | Description |
|---|---|
| getAllGroupIds() | Returns all of the group IDs. |
| getAllGroups() | Returns all category groups. |
| getEditableGroupIds() | Returns all of the category group IDs that are editable by the current user. |
| getEditableGroups() | Returns all editable groups. |
| getGroupByHandle() | Returns a group by its handle. |
| getGroupById() | Returns a group by its ID. |
| getTotalGroups() | Gets the total number of category groups. |
getAllGroupIds() ​
Returns all of the group IDs.
Returns ​
integer[]
getAllGroups() ​
Returns all category groups.
Arguments ​
Returns ​
getEditableGroupIds() ​
Returns all of the category group IDs that are editable by the current user.
Returns ​
integer[]
getEditableGroups() ​
Returns all editable groups.
Arguments ​
Returns ​
getGroupByHandle() ​
Returns a group by its handle.
Arguments ​
$groupHandle(string)
Returns ​
craft\models\CategoryGroup, null
getGroupById() ​
Returns a group by its ID.
Arguments ​
$groupId(integer)
Returns ​
craft\models\CategoryGroup, null
getTotalGroups() ​
Gets the total number of category groups.