Smarty Manual
Prev | Chapter 5. Variable Modifiers | Next

# escape

Parameter Position | Type | Required | Possible Values | Default | Description
--- | --- | --- | --- | --- | ---
1 | string | No | html,htmlall,url,quotes,hex,hexentity,javascript | html | This is the escape format to use.

This is used to html escape, url escape, escape single quotes on a variable not already escaped, hex escape, hexentity or javascript escape. By default, the variable is html escaped.

Example 5-10. escape
`<?php $smarty = new Smarty; $smarty->assign('articleTitle', "'Stiff Opposition Expected to Casketless Funeral Plan'"); $smarty->display('index.tpl'); ?>`
Where index.tpl is:
    {$articleTitle}
    {$articleTitle|escape}
    {$articleTitle|escape:"html"}    {* escapes  & " ' < > *}
    {$articleTitle|escape:"htmlall"} {* escapes ALL html entities *}
    {$articleTitle|escape:"url"}
    {$articleTitle|escape:"quotes"}
    <a href="mailto:{$EmailAddress|escape:"hex"}">{$EmailAddress|escape:"hexentity"}</a>
This will output:
    'Stiff Opposition Expected to Casketless Funeral Plan'
    &#039;Stiff Opposition Expected to Casketless Funeral Plan&#039;
    &#039;Stiff Opposition Expected to Casketless Funeral Plan&#039;
    &#039;Stiff Opposition Expected to Casketless Funeral Plan&#039;
    %27Stiff+Opposition+Expected+to+Casketless+Funeral+Plan%27
    \'Stiff Opposition Expected to Casketless Funeral Plan\'
    <a href="mailto:%62%6f%62%40%6d%65%2e%6e%65%74">&#x62;&#x6f;&#x62;&#x40;&#x6d;&#x65;&#x2e;&#x6e;&#x65;&#x74;</a>

Prev | Home | Next
default | Up | indent