Get all tags used by templates
Available since version 3.0.176. + hookable in 3.0.179
Usage
// basic usage
$array = $templates->getTags();
// usage with all arguments
$array = $templates->getTags(bool $getTemplateNames = false);
Arguments
Name | Type(s) | Description |
---|---|---|
getTemplateNames (optional) | bool | Get arrays of template names for each tag? (default=false) |
Return value
array
In return value both key and value are the tag
Hooking $templates->getTags(…)
You can add your own hook events that are executed either before or after the $templates
method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.
Hooking before
The 'before' hooks are called immediately before each $templates
method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('Templates::getTags', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$templates = $event->object;
// Get values of arguments sent to hook (and optionally modify them)
$getTemplateNames = $event->arguments(0);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $getTemplateNames);
});
Hooking after
The 'after' hooks are called immediately after each $templates
method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.
$this->addHookAfter('Templates::getTags', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$templates = $event->object;
// An 'after' hook can retrieve and/or modify the return value
$return = $event->return;
// Get values of arguments sent to hook (if needed)
$getTemplateNames = $event->arguments(0);
/* Your code here, perhaps modifying the return value */
// Populate back return value, if you have modified it
$event->return = $return;
});
$templates methods and properties
API reference based on ProcessWire core version 3.0.236