<HTML
><HEAD
><TITLE
>escape</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="HOME"
TITLE="Smarty Manual"
HREF="index.html"><LINK
REL="UP"
TITLE="Variable Modifiers"
HREF="language.modifiers.html"><LINK
REL="PREVIOUS"
TITLE="default"
HREF="language.modifier.default.html"><LINK
REL="NEXT"
TITLE="indent"
HREF="language.modifier.indent.html"><META
HTTP-EQUIV="Content-type"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="sect1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>Smarty Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="language.modifier.default.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 5. Variable Modifiers</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="language.modifier.indent.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="sect1"
><H1
CLASS="sect1"
><A
NAME="language.modifier.escape"
></A
>escape</H1
><P
> This is used to encode/escape a variable to <TT
CLASS="literal"
>html</TT
>,
<TT
CLASS="literal"
>url</TT
>, <TT
CLASS="literal"
>single quotes</TT
>,
<TT
CLASS="literal"
>hex</TT
>, <TT
CLASS="literal"
>hexentity</TT
>,
<TT
CLASS="literal"
>javascript</TT
> and <TT
CLASS="literal"
>mail</TT
>.
By default its <TT
CLASS="literal"
>html</TT
> escaped.
</P
><DIV
CLASS="informaltable"
><A
NAME="AEN948"
></A
><P
></P
><TABLE
BORDER="1"
CLASS="CALSTABLE"
><THEAD
><TR
><TH
WIDTH="17%"
ALIGN="CENTER"
VALIGN="MIDDLE"
>Parameter Position</TH
><TH
WIDTH="17%"
ALIGN="CENTER"
VALIGN="MIDDLE"
>Type</TH
><TH
WIDTH="17%"
ALIGN="CENTER"
VALIGN="MIDDLE"
>Required</TH
><TH
WIDTH="17%"
ALIGN="CENTER"
VALIGN="MIDDLE"
>Possible Values</TH
><TH
WIDTH="17%"
ALIGN="CENTER"
VALIGN="MIDDLE"
>Default</TH
><TH
WIDTH="17%"
ALIGN="LEFT"
VALIGN="MIDDLE"
>Description</TH
></TR
></THEAD
><TBODY
><TR
><TD
WIDTH="17%"
ALIGN="CENTER"
VALIGN="MIDDLE"
>1</TD
><TD
WIDTH="17%"
ALIGN="CENTER"
VALIGN="MIDDLE"
>string</TD
><TD
WIDTH="17%"
ALIGN="CENTER"
VALIGN="MIDDLE"
>No</TD
><TD
WIDTH="17%"
ALIGN="CENTER"
VALIGN="MIDDLE"
><TT
CLASS="literal"
>html</TT
>, <TT
CLASS="literal"
>htmlall</TT
>,
<TT
CLASS="literal"
>url</TT
>,
<TT
CLASS="literal"
>urlpathinfo</TT
>, <TT
CLASS="literal"
>quotes</TT
>,
<TT
CLASS="literal"
>hex</TT
>, <TT
CLASS="literal"
>hexentity</TT
>,
<TT
CLASS="literal"
>javascript</TT
>, <TT
CLASS="literal"
>mail</TT
>
</TD
><TD
WIDTH="17%"
ALIGN="CENTER"
VALIGN="MIDDLE"
><TT
CLASS="literal"
>html</TT
></TD
><TD
WIDTH="17%"
ALIGN="LEFT"
VALIGN="MIDDLE"
>This is the escape format to use.</TD
></TR
><TR
><TD
WIDTH="17%"
ALIGN="CENTER"
VALIGN="MIDDLE"
>2</TD
><TD
WIDTH="17%"
ALIGN="CENTER"
VALIGN="MIDDLE"
>string</TD
><TD
WIDTH="17%"
ALIGN="CENTER"
VALIGN="MIDDLE"
>No</TD
><TD
WIDTH="17%"
ALIGN="CENTER"
VALIGN="MIDDLE"
><TT
CLASS="literal"
>ISO-8859-1</TT
>, <TT
CLASS="literal"
>UTF-8</TT
>,
and any character set supported by
<A
HREF="http://php.net/htmlentities"
TARGET="_top"
> <TT
CLASS="varname"
>htmlentities()</TT
></A
>
</TD
><TD
WIDTH="17%"
ALIGN="CENTER"
VALIGN="MIDDLE"
><TT
CLASS="literal"
>ISO-8859-1</TT
></TD
><TD
WIDTH="17%"
ALIGN="LEFT"
VALIGN="MIDDLE"
>The character set encoding passed to htmlentities() et. al.</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN994"
></A
><P
><B
>Example 5-10. escape</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$smarty</span><span style="color: #007700">-></span><span style="color: #0000BB">assign</span><span style="color: #007700">(</span><span style="color: #DD0000">'articleTitle'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"'Stiff Opposition Expected to Casketless Funeral Plan'"<br /> </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$smarty</span><span style="color: #007700">-></span><span style="color: #0000BB">assign</span><span style="color: #007700">(</span><span style="color: #DD0000">'EmailAddress'</span><span style="color: #007700">,</span><span style="color: #DD0000">'smarty@example.com'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></TD
></TR
></TABLE
><P
> Where template is:
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><PRE
CLASS="programlisting"
>{$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>
{$EmailAddress|escape:'mail'} {* this converts to email to text *}
{'mail@example.com'|escape:'mail'}</PRE
></TD
></TR
></TABLE
><P
> Will output:
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><PRE
CLASS="screen"
>'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%..snip..%65%74">&#x62;&#x6f;&#x62..snip..&#x65;&#x74;</a>
smarty [AT] example [DOT] com
mail [AT] example [DOT] com</PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN1001"
></A
><P
><B
>Example 5-11. Other examples</B
></P
><P
>PHP functions can be used as modifiers,
<A
HREF="variable.security.html"
> <TT
CLASS="varname"
>$security</TT
></A
> permitting.
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><PRE
CLASS="screen"
>{* the "rewind" paramater registers the current location *}
<a href="{$SCRIPT_NAME}?page=foo&rewind={$smarty.server.REQUEST_URI|urlencode}">click here</a></PRE
></TD
></TR
></TABLE
><P
>This snippet is useful for emails, but see also
<A
HREF="language.function.mailto.html"
> <TT
CLASS="varname"
>{mailto}</TT
></A
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><PRE
CLASS="screen"
>{* email address mangled *}
<a href="mailto:{$EmailAddress|escape:'hex'}">{$EmailAddress|escape:'mail'}</a></PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
><P
> See also
<A
HREF="language.escaping.html"
>escaping smarty parsing</A
>,
<A
HREF="language.function.mailto.html"
><TT
CLASS="varname"
>{mailto}</TT
></A
>
and the
<A
HREF="tips.obfuscating.email.html"
>obfuscating email addresses</A
> page.
</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="language.modifier.default.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="language.modifier.indent.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>default</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="language.modifiers.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>indent</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
