Jump to main content Jump to doc navigation

Event: OnTemplateVarBeforeRemove

Loaded right before 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
Next event OnTemplateVarRemove
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 'OnTemplateVarBeforeRemove':
        //array tv, with all parameters
        print_r($templateVar->toArray());
        break;
}

See Also

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.

Backers

  • modmore
  • modmore
  • Jens Wittmann – Gestaltung & Entwicklung
  • Raffy
  • eydolan
  • Digital Penguin
  • Fabian Christen
  • Dannevang Digital
  • deJaya
  • Sepia River Studios
  • Following Sea
  • Anton Tarasov
  • Lefthandmedia
  • Nick Clark
  • Chris Fickling
  • Murray Wood
  • YJ
  • CrewMark
  • Richard

Budget

$305 per month—let's make that $500!

Learn more