Environment Functions

These functions let you check the values of your plugin settings and check for form submissions.

You can use syntax of the form:

$this->functionName()

to call an environment function from anywhere within your Plugin's methods.

allowCaching()

This function lets you tell the CMS that your Plugin supports caching, and under which situations it can be cached.

callScript()

Lets you call JavaScript functions after your Plugin has been displayed on a page, or after your Plugin has been reloaded via AJAX.

callScriptBeforeAJAXReload()

This is an alternate version of callScript(), that allows you to run a script before your Plugin is placed in a slot or reloaded via AJAX.

checkPostIsMine()

This function checks whether there is data in the $_POST array, and whether that data is from a form created by the current Plugin (as opposed to data from another Plugin on the current page).

clearCacheBy()

This function lets you tell the CMS when any cached copies of your Plugin should be cleared.