owsimpleoperator: write a template operator in a few lines #

This page is for developers who need a small template operator, or want templates to call a PHP function. A full operator class is often more work than the operator deserves. owsimpleoperator (from Open Wide) lets you write each operator as a small class with plain methods: less boilerplate and more readable code. It also lets templates call PHP functions and class methods as operators, but only those you list explicitly.

What you get #

• Call any permitted PHP function as a template operator.
• Utility methods for your PHP code: string manipulation, object attribute manipulation, object type control and output manipulation.

Constraints:

• An optional operator argument must default to null.
• For more than 10 arguments, override $max_operator_parameter.

Allow a PHP function or class method #

Nothing is callable unless you list it in owsimpleoperator.ini. This is what ships:

[PHPFunctions]
PermittedFunctionList[]
PermittedFunctionList[]=time
PermittedFunctionList[]=mktime
PermittedFunctionList[]=getdate
PermittedFunctionList[]=str_replace
PermittedFunctionList[]=str_rot13
PermittedFunctionList[]=file_get_contents
[ClassOperators]
PermittedClassOperatorList[]
[OWSimpleOperatorSettings]
DebugOutput=enabled

Security: file_get_contents lets a template read any file the web server can read. Remove it from the list on production sites that do not need it (the other entries are harmless). A function that is not permitted cannot be called from a template.

What changed in the Exponential 6 releases #

Related pages #

• swark: ready-made operators in the same spirit
• String template operators
• Extension metadata specification
• Chronicle and release notes
• Change ledger
• Behaviour changes of the extensions
• Months: 2024-01, 2026-09 (all extensions)