Actions

Difference between revisions of "Plugin events"

From LimeSurvey Manual

(Global Events: setVariableExpressionEnd)
(added details for availability)
Line 15: Line 15:
 
*[[afterSurveySettingsSave]]
 
*[[afterSurveySettingsSave]]
 
*[[beforeActivate]]
 
*[[beforeActivate]]
*[[beforeAdminMenuRender]]
+
*[[beforeAdminMenuRender]] {{NewIn|v=2.50|b=160426}}
 
*[[beforeEmail]]{{NewIn|v=4.0.0}}
 
*[[beforeEmail]]{{NewIn|v=4.0.0}}
 
*[[beforeCloseHtml]]{{NewIn|v=2.60.0}}
 
*[[beforeCloseHtml]]{{NewIn|v=2.60.0}}

Revision as of 10:07, 3 October 2019

At version 2.50 build 160425 the following events are available for plugins to subscribe to:

NB: Version 2.60.0 is not the same as version 2.6, which is the new number for version 2.06. 2.60.0 comes after 2.59.1.

Global Events

CLI Events

This events needs to be called with php cli command.

  • cron (New in 2.05 build 140404)
  • direct (New in 2.63.0 build 170304)

Authentification related events


Model Events

All models (Survey, Question, etc.) support a series of before & after events.

Specific Model events

These include model-specific events (example for Survey model):

  • beforeSurveyDelete
  • beforeSurveySave
  • afterSurveyDelete
  • afterSurveySave

Dynamic model events (New in 3.15.1 )

  • beforeTokenDelete
  • beforeTokenSave
  • afterTokenDelete
  • afterTokenSave
  • beforeResponseDelete
  • beforeResponseSave
  • afterResponseDelete
  • afterResponseSave
  • beforeTokenDynamicDelete
  • beforeTokenDynamicSave
  • afterTokenDynamicDelete
  • afterTokenDynamicSave
  • beforeSurveyDynamicDelete
  • beforeSurveyDynamicSave
  • afterSurveyDynamicDelete
  • afterSurveyDynamicSave

Generic events

As well as generic events independent of the model's name:

In all of the above events, the associated model object is available as part of event data:

$model = $this->event->get('model');