Jump to main content Jump to doc navigation

Event: OnTemplateVarBeforeSave

Loaded right before saving a template variable to database.

  • Service: 1 - Parser Service Events
  • Group: Template Variables

Event Parameters

Name Description
mode Either 'new' or 'upd', depending on the circumstances.
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.

Remarks

Previous event
Next event OnTemplateVarSave
File core/model/modx/modtemplatevar.class.php
Class modTemplateVar
Method public function save($cacheFlag = null)

Example

Such a plugin will display the data of the saved TV in the "Error log":

<?php
$eventName = $modx->event->name;
switch($eventName) {
    case 'OnTemplateVarBeforeSave':
        //array tv, with all parameters
        print_r($templateVar->toArray());
        //checking for updating or creating the tv itself
        if ($mode == modSystemEvent::MODE_NEW){
            echo 'A new TV was created';
        } elseif ($mode == modSystemEvent::MODE_UPD){
            echo 'Old TV has been updated';
        }
        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
  • Jens Wittmann – Gestaltung & Entwicklung
  • Digital Penguin
  • eydolan
  • deJaya
  • Following Sea
  • Nick Clark
  • Lefthandmedia
  • YJ
  • Sepia River Studios
  • Murray Wood
  • Dannevang Digital
  • Richard

Budget

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

Learn more