Tags
- Type
- Class
- Namespace
- craft\services
- Inherits
- craft\services\Tags » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 3.0.0
Tags service.
An instance of the service is available via Craft::$app->tags
.
View source (opens new window)
# Public Properties
Property | Description |
---|---|
allTagGroupIds | array (opens new window) |
allTagGroups | craft\models\TagGroup[] |
behaviors (opens new window) | yii\base\Behavior (opens new window) – List of behaviors attached to this component. |
totalTagGroups | integer (opens new window) |
# allTagGroupIds
- Type
- array (opens new window)
- Default value
null
- Access
- Read-only
View source (opens new window)
# allTagGroups
- Type
- craft\models\TagGroup[]
- Default value
null
- Access
- Read-only
View source (opens new window)
# totalTagGroups
- Type
- integer (opens new window)
- Default value
null
- Access
- Read-only
View source (opens new window)
# Public Methods
Method | Description |
---|---|
__call() (opens new window) | Calls the named method which is not a class method. |
__clone() (opens new window) | This method is called after the object is created by cloning an existing one. |
__construct() (opens new window) | Constructor. |
__get() (opens new window) | Returns the value of a component property. |
__isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
__serialize() | Serializer |
__set() (opens new window) | Sets the value of a component property. |
__unset() (opens new window) | Sets a component property to be null. |
attachBehavior() (opens new window) | Attaches a behavior to this component. |
attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
behaviors() (opens new window) | Returns a list of behaviors that this component should behave as. |
canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
className() (opens new window) | Returns the fully qualified name of this class. |
deleteTagGroup() | Deletes a tag group. |
deleteTagGroupById() | Deletes a tag group by its ID. |
detachBehavior() (opens new window) | Detaches a behavior from the component. |
detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
getAllTagGroupIds() | Returns all of the group IDs. |
getAllTagGroups() | Returns all tag groups. |
getBehavior() (opens new window) | Returns the named behavior object. |
getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
getTagById() | Returns a tag by its ID. |
getTagGroupByHandle() | Gets a group by its handle. |
getTagGroupById() | Returns a group by its ID. |
getTagGroupByUid() | Returns a group by its UID. |
getTotalTagGroups() | Gets the total number of tag groups. |
handleChangedTagGroup() | Handle tag group change |
handleDeletedTagGroup() | Handle Tag group getting deleted |
hasEventHandlers() (opens new window) | Returns a value indicating whether there is any handler attached to the named event. |
hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
hasProperty() (opens new window) | Returns a value indicating whether a property is defined for this component. |
init() (opens new window) | Initializes the object. |
off() (opens new window) | Detaches an existing event handler from this component. |
on() (opens new window) | Attaches an event handler to an event. |
pruneDeletedField() | |
saveTagGroup() | Saves a tag group. |
trigger() (opens new window) | Triggers an event. |
# __serialize()
- Since
- 3.5.14
Serializer
View source (opens new window)
# deleteTagGroup()
Deletes a tag group.
View source (opens new window)
Arguments
$tagGroup
(craft\models\TagGroup) – The tag group
Returns
boolean (opens new window) – Whether the tag group was deleted successfully
Throws
- Throwable (opens new window)
if reasons
# deleteTagGroupById()
- Since
- 3.0.12
Deletes a tag group by its ID.
View source (opens new window)
Arguments
$groupId
(integer (opens new window)) – The tag group's ID
Returns
boolean (opens new window) – Whether the tag group was deleted successfully
Throws
- Throwable (opens new window)
if reasons
# getAllTagGroupIds()
Returns all of the group IDs.
View source (opens new window)
Returns
# getAllTagGroups()
Returns all tag groups.
View source (opens new window)
Returns
# getTagById()
Returns a tag by its ID.
View source (opens new window)
Arguments
$tagId
(integer (opens new window))$siteId
(integer (opens new window), null (opens new window))
Returns
craft\elements\Tag, null (opens new window)
# getTagGroupByHandle()
Gets a group by its handle.
View source (opens new window)
Arguments
$groupHandle
(string (opens new window))$withTrashed
(boolean (opens new window))
Returns
craft\models\TagGroup, null (opens new window)
# getTagGroupById()
Returns a group by its ID.
View source (opens new window)
Arguments
$groupId
(integer (opens new window))
Returns
craft\models\TagGroup, null (opens new window)
# getTagGroupByUid()
Returns a group by its UID.
View source (opens new window)
Arguments
$groupUid
(string (opens new window))
Returns
craft\models\TagGroup, null (opens new window)
# getTotalTagGroups()
Gets the total number of tag groups.
View source (opens new window)
Returns
# handleChangedTagGroup()
Handle tag group change
View source (opens new window)
Arguments
$event
(craft\events\ConfigEvent)
# handleDeletedTagGroup()
Handle Tag group getting deleted
View source (opens new window)
Arguments
$event
(craft\events\ConfigEvent)
# pruneDeletedField()
DEPRECATED
Deprecated in 4.0.5. Unused fields will be pruned automatically as field layouts are resaved.
View source (opens new window)
# saveTagGroup()
Saves a tag group.
View source (opens new window)
Arguments
$tagGroup
(craft\models\TagGroup) – The tag group to be saved$runValidation
(boolean (opens new window)) – Whether the tag group should be validated
Returns
boolean (opens new window) – Whether the tag group was saved successfully
Throws
- craft\errors\TagGroupNotFoundException
if $tagGroup->id is invalid - Throwable (opens new window)
if reasons
# Events
# EVENT_AFTER_DELETE_GROUP
The event that is triggered after a tag group is deleted.
# EVENT_AFTER_SAVE_GROUP
The event that is triggered after a tag group is saved.
# EVENT_BEFORE_APPLY_GROUP_DELETE
- Type
- craft\events\TagGroupEvent
- Since
- 3.1.0
The event that is triggered before a tag group delete is applied to the database.
# EVENT_BEFORE_DELETE_GROUP
The event that is triggered before a tag group is deleted.
# EVENT_BEFORE_SAVE_GROUP
The event that is triggered before a tag group is saved.