Plugin Smarty

Introduced in Tiki5

Use this wiki plugin to insert a Smarty function in a page. Smarty is the template engine used in Tiki.

Parameters

Insert a Smarty function or variable
Introduced in Tiki 5. Required parameters are in bold.
Go to the source code
Preferences required: wikiplugin_smarty

Parameters Accepted Values Description Default Since
name word The name of the Smarty function that the plugin will activate. Available functions can be found at lib/smarty_tiki/function.(name).php and vendor_bundled/vendor/smarty/smarty/libs/plugins/function.(name).php 7.0


In addition, the smarty function parameters that are required or allowed should or may be set. The functions available can be found as separate files on the server for each function (name) as follows:

  • lib/smarty_tiki/function.(name).php
  • vendor/smarty/libs/plugins/function.(name).php

Examples

Function to add a button

This code:

Copy to clipboard
{smarty name="button" href="Search" _text="Search"}


Would produce:
Search

Variables

Smarty variables can be displayed by using the eval Smarty function. The available Smarty variables for a page can be viewed by Admins by clicking the "Smarty debug window" option in the Quick Administration menu. Or add ?show_smarty_debug=1 to the page address (or &show_smarty_debug=1 if there are already other url parameters). See below examples.

Smarty variables - page name

This code:

Copy to clipboard
{smarty name="eval" var="{$page}"}


Would produce on this page:
PluginSmarty

Smarty global variables - domain name

Global variables can be accessed too, such as the domain name -
This code:

Copy to clipboard
{smarty name="eval" var="{$smarty.server.HTTP_HOST}"}


Would produce on this site:
doc.tiki.org.

Preferences - metatag keywords

This code:

Copy to clipboard
{smarty name="eval" var="{$prefs.metatag_keywords}"}


Would produce on this site:
documentation, tiki, tikiwiki, document, help, install, wiki syntax

Related pages