htmlentities

Description
Syntax
Examples
Links

Description

The htmlentities of String for PHP convert all applicable characters to HTML entities.

Syntax

htmlentities(
    string $string,
    int $flags = ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401,
    ?string $encoding = null,
    bool $double_encode = true
): string

Parameters

flags

A bitmask of one or more of the following flags, which specify how to handle quotes, invalid code unit sequences and the used document type. The default is ENT_COMPAT | ENT_HTML401.

Constant	Description
ENT_COMPAT	Will convert double-quotes and leave single-quotes alone.
ENT_QUOTES	Will convert both double and single quotes.
ENT_NOQUOTES	leave both double and single quotes unconverted.
ENT_IGNORE	Silently discard invalid code unit sequences instead of returning an empty string. Using this flag is discouraged as it may have security implications.
ENT_SUBSTITUTE	Replace invalid code unit sequences with a Unicode Replacement Character U+FFFD (UTF-8) or &#FFFD; (otherwise) instead of returning an empty string.
ENT_DISALLOWED	Replace invalid code points for the given document type with a Unicode Replacement Character U+FFFD (UTF-8) or &#FFFD; (otherwise) instead of leaving them as is. This may be useful, for instance, to ensure the well-formedness of XML documents with embedded external content.
ENT_HTML401	Handle code as HTML 4.01.
ENT_XML1	Handle code as XML 1.
ENT_XHTML	Handle code as XHTML.
ENT_HTML5	Handle code as HTML 5.

An optional argument defining the encoding used when converting characters. If omitted, the default value of the encoding varies depending on the PHP version in use. In PHP 5.6 and later, the default_charset configuration option is used as the default value. PHP 5.4 and 5.5 will use UTF-8 as the default. Earlier versions of PHP use ISO-8859-1. Although this argument is technically optional, you are highly encouraged to specify the correct value for your code if you are using PHP 5.5 or earlier, or if your default_charset configuration option may be set incorrectly for the given input.

Charset	Aliases	Description
ISO-8859-1	ISO8859-1	Western European, Latin-1.
ISO-8859-5	ISO8859-5	Little used cyrillic charset (Latin/Cyrillic).
ISO-8859-15	ISO8859-15	Western European, Latin-9. Adds the Euro sign, French and Finnish letters missing in Latin-1 (ISO-8859-1).
UTF-8		ASCII compatible multi-byte 8-bit Unicode.
cp866	ibm866, 866	DOS-specific Cyrillic charset.
cp1251	Windows-1251, win-1251, 1251	Windows-specific Cyrillic charset.
cp1252	Windows-1252, 1252	Windows specific charset for Western European.
KOI8-R	koi8-ru, koi8r	Russian
BIG5	950	Traditional Chinese, mainly used in Taiwan.
GB2312	936	Simplified Chinese, national standard character set.
BIG5-HKSCS		Big5 with Hong Kong extensions, Traditional Chinese.
Shift_JIS	SJIS, SJIS-win, cp932, 932	Japanese
EUC-JP	EUCJP, eucJP-win	Japanese
MacRoman		Charset that was used by Mac OS.
''		An empty string activates detection from script encoding (Zend multibyte), default_charset and current locale (see nl_langinfo() and setlocale()), in this order. Not recommended.

NOTE: Any other character sets are not recognized. The default encoding will be used instead and a warning will be emitted.

<?

$string = "& | &amp;"
. PHP_EOL . "\" | &quot;"
. PHP_EOL . "' | &#039;"
. PHP_EOL . "< | &lt;"
. PHP_EOL . "> | &gt;"
. PHP_EOL . "über | &uuml;ber"
. PHP_EOL . "<b>bold</b> | &lt;b&gt;bold&lt;/b&gt;";

$return = htmlentities($string);
echo $return;

?>

&amp; | &amp;amp;
&quot; | &amp;quot;
&#039; | &amp;#039;
&lt; | &amp;lt;
&gt; | &amp;gt;
&uuml;ber | &amp;uuml;ber
&lt;b&gt;bold&lt;/b&gt; | &amp;lt;b&amp;gt;bold&amp;lt;/b&amp;gt;

2 · flags

<?

$string = "& | &amp;"
. PHP_EOL . "\" | &quot;"
. PHP_EOL . "' | &#039;"
. PHP_EOL . "< | &lt;"
. PHP_EOL . "> | &gt;"
. PHP_EOL . "über | &uuml;ber"
. PHP_EOL . "<b>bold</b> | &lt;b&gt;bold&lt;/b&gt;";
$flags = ENT_QUOTES;

$return = htmlentities($string, $flags);
echo $return;

?>

&amp; | &amp;amp;
&quot; | &amp;quot;
&#039; | &amp;#039;
&lt; | &amp;lt;
&gt; | &amp;gt;
&uuml;ber | &amp;uuml;ber
&lt;b&gt;bold&lt;/b&gt; | &amp;lt;b&amp;gt;bold&amp;lt;/b&amp;gt;

3 · encoding

<?

$string = "& | &amp;"
. PHP_EOL . "\" | &quot;"
. PHP_EOL . "' | &#039;"
. PHP_EOL . "< | &lt;"
. PHP_EOL . "> | &gt;"
. PHP_EOL . "über | &uuml;ber"
. PHP_EOL . "<b>bold</b> | &lt;b&gt;bold&lt;/b&gt;";
$flags = ENT_QUOTES;
$encoding = "UTF-8";

$return = htmlentities($string, $flags, $encoding);
echo $return;

?>

&amp; | &amp;amp;
&quot; | &amp;quot;
&#039; | &amp;#039;
&lt; | &amp;lt;
&gt; | &amp;gt;
&uuml;ber | &amp;uuml;ber
&lt;b&gt;bold&lt;/b&gt; | &amp;lt;b&amp;gt;bold&amp;lt;/b&amp;gt;

4 · double_encode

<?

$string = "& | &amp;"
. PHP_EOL . "\" | &quot;"
. PHP_EOL . "' | &#039;"
. PHP_EOL . "< | &lt;"
. PHP_EOL . "> | &gt;"
. PHP_EOL . "über | &uuml;ber"
. PHP_EOL . "<b>bold</b> | &lt;b&gt;bold&lt;/b&gt;";
$flags = ENT_QUOTES;
$encoding = "UTF-8";
$double_encode = false;

$return = htmlentities($string, $flags, $encoding, $double_encode);
echo $return;

?>

&amp; | &amp;
&quot; | &quot;
&#039; | &#039;
&lt; | &lt;
&gt; | &gt;
&uuml;ber | &uuml;ber
&lt;b&gt;bold&lt;/b&gt; | &lt;b&gt;bold&lt;/b&gt;