OnTemplateVarRemove
Last updated Sep 18th, 2020 | Page history | Improve this page | Report an issue
Event: OnTemplateVarRemove¶
Loaded right after successful removing a template variable.
- Service: 1 - Parser Service Events
- Group: Template Variables
Event Parameters¶
| Name | Description |
|---|---|
| templateVar | The instance of modTemplateVar class. |
| cacheFlag | Indicates if the saved TV should be cached and optionally, by specifying an integer value, for how many seconds before expiring. Returns always 'true' |
Remarks¶
| Previous event | OnTemplateVarBeforeRemove |
|---|---|
| Next event | — |
| File | core/model/modx/modtemplatevar.class.php |
| Class | modTemplateVar |
| Method | public function remove(array $ancestors= array ()) |
Example¶
Such a plugin will display the remote TV data in the "Error log":
<?php
$eventName = $modx->event->name;
switch($eventName) {
case 'OnTemplateVarRemove':
//array tv, with all parameters
print_r($templateVar->toArray());
break;
}