<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/strings.xml, last change in rev 1.2 -->
  <refentry id="function.htmlentities">
   <refnamediv>
    <refname>htmlentities</refname>
    <refpurpose>
     Convert all applicable characters to HTML entities
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>htmlentities</methodname>
      <methodparam><type>string</type><parameter>string</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>quote_style</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
     </methodsynopsis>
    <para>
     This function is identical to
     <function>htmlspecialchars</function> in all ways, except with
     <function>htmlentities</function>, all characters which have HTML 
     character entity equivalents are translated into these entities.
    </para>
    <para>
     Like <function>htmlspecialchars</function>, the optional second 
     <parameter>quote_style</parameter> parameter lets you define what will 
     be done with 'single' and "double" quotes.  It takes on one of three 
     constants with the default being <constant>ENT_COMPAT</constant>:
     <table>
      <title>Available <parameter>quote_style</parameter> constants</title>
      <tgroup cols="2">
       <thead>
        <row>
         <entry>Constant Name</entry>
         <entry>Description</entry>
        </row>
       </thead>
       <tbody>
        <row>
         <entry><constant>ENT_COMPAT</constant></entry>
         <entry>Will convert double-quotes and leave single-quotes alone.</entry>
        </row>
        <row>
         <entry><constant>ENT_QUOTES</constant></entry>
         <entry>Will convert both double and single quotes.</entry>
        </row>
        <row>
         <entry><constant>ENT_NOQUOTES</constant></entry>
         <entry>Will leave both double and single quotes unconverted.</entry>
        </row>
       </tbody>
      </tgroup>
     </table>
    </para>
    <para>
     Support for the optional <parameter>quote</parameter> parameter was
     added in PHP 4.0.3.
    </para>
    <para>
     Like <function>htmlspecialchars</function>, it takes an optional
     third argument <parameter>charset</parameter> which defines character
     set used in conversion. Support for this argument was added in PHP 4.1.0.
     Presently, the ISO-8859-1 character set is used as the default.
    </para>
    &reference.strings.charsets;
    <para>
     If you're wanting to decode instead (the reverse) you can use
     <function>html_entity_decode</function>.
    </para>
    <para>
     See also <function>html_entity_decode</function>, 
     <function>get_html_translation_table</function>,
     <function>htmlspecialchars</function>, <function>nl2br</function>,
     and <function>urlencode</function>.
    </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
-->