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
View source (opens new window)
# 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.
View source (opens new window)
Returns
# getAllGroups()
Returns all category groups.
View source (opens new window)
Arguments
$indexBy(string (opens new window), null (opens new window))
Returns
# getEditableGroupIds()
Returns all of the category group IDs that are editable by the current user.
View source (opens new window)
Returns
# getEditableGroups()
Returns all editable groups.
View source (opens new window)
Arguments
$indexBy(string (opens new window), null (opens new window))
Returns
# getGroupByHandle()
Returns a group by its handle.
View source (opens new window)
Arguments
$groupHandle(string (opens new window))
Returns
craft\models\CategoryGroup, null (opens new window)
# getGroupById()
Returns a group by its ID.
View source (opens new window)
Arguments
$groupId(integer (opens new window))
Returns
craft\models\CategoryGroup, null (opens new window)
# getTotalGroups()
Gets the total number of category groups.
View source (opens new window)
Returns
← TagTokenParser Config →