smarty/docs/en/programmers/api-functions/api-clear-assign.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry id="api.clear.assign">
 <refnamediv>
  <refname>clear_assign()</refname>
  <refpurpose>clears the value of an assigned variable</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>void</type><methodname>clear_assign</methodname>
   <methodparam><type>mixed</type><parameter>var</parameter></methodparam>
  </methodsynopsis>
  <para>
This  can be a single value, or an array of values.
  </para>
  <example>
   <title>clear_assign()</title>
   <programlisting role="php">
<![CDATA[
<?php
// clear a single variable
$smarty->clear_assign('Name');

// clears multiple variables
$smarty->clear_assign(array('Name', 'Address', 'Zip'));
?>
]]>
   </programlisting>
  </example>
  <para>
    See also
    <link linkend="api.clear.all.assign">clear_all_assign()</link>,
    <link linkend="api.clear.config">clear_config()</link>,
    <link linkend="api.get.template.vars">get_template_vars()</link>,
    <link linkend="api.assign">assign()</link>
    and <link linkend="api.append">append()</link>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->