Chapter 8. Extending Smarty With Plugins

Table of Contents
How Plugins Work
Naming Conventions
Writing Plugins
Template Functions
Modifiers
Compiler Functions
Prefilters/Postfilters
Resources
Inserts

Version 2.0 introduced the plugin architecture that is used for almost all the customizable functionality of Smarty. This includes:

With the exception of resources, backwards compatibility with the old way of registering handler functions via register_* API is preserved. If you did not use the API but instead modified the class variables $custom_funcs, $custom_mods, and other ones directly, then you will need to adjust your scripts to either use the API or convert your custom functionality into plugins.

How Plugins Work

Plugins are always loaded on demand. Only the specific modifiers, functions, resources, etc invoked in the templates or PHP scripts will be loaded. Moreover, each plugin is loaded only once, even if you have several different instances of Smarty running within the same request.

Pre/post-filters are a bit of a special case. If a pre/post-filter plugin is found in the plugins directory, it will always be loaded because these filters are never explicitly mentioned in the template language. This also means that the order in which multiple prefilters or postfilters is executed depends on the way they are named (basically, alphabetical order).

There is only one plugins directory (for performance reasons). To install a plugin, simply place it in the directory and Smarty will use it automatically.