PHP htmlentities() Function
Example
Convert some characters to HTML entities:
$str = "<© W3Sçh°°¦§>";
echo htmlentities($str);
?>
The HTML output of the code above will be (View Source):
<html>
<body>
<© W3Sçh°°¦§>
</body>
</html>
The browser output of the code above will be:
Definition and Usage
The htmlentities() function converts characters to HTML entities.
Tip: To convert HTML entities back to characters, use the html_entity_decode() function.
Tip: Use the get_html_translation_table() function to return the translation table used by htmlentities().
Syntax
| Parameter | Description |
|---|---|
| string | Required. Specifies the string to convert |
| flags | Optional. Specifies how to handle quotes, invalid encoding and the used
document type. The available quote styles are:
Invalid encoding:
Additional flags for specifying the used doctype:
|
| character-set | Optional. A string that specifies which character-set to use. Allowed values are:
Note: Unrecognized character-sets will be ignored and replaced by ISO-8859-1 in versions prior to PHP 5.4. As of PHP 5.4, it will be ignored an replaced by UTF-8. |
| double_encode | Optional. A boolean value that specifies whether to encode existing html
entities or not.
|
Technical Details
| Return Value: | Returns the converted string If the string contains invalid encoding, it will return an empty string, unless either the ENT_IGNORE or ENT_SUBSTITUTE flags are set |
|---|---|
| PHP Version: | 4+ |
| Changelog: | The default value for the character-set parameter was changed
to UTF-8 in PHP 5 ENT_SUBSTITUTE, ENT_DISALLOWED, ENT_HTML401, ENT_HTML5, ENT_XML1 and ENT_XHTML were added in PHP 5.4 ENT_IGNORE was added in PHP 5.3 The double_encode parameter was added in PHP 5.2.3 The character-set parameter was added in PHP 4.1 |
More Examples
Example 1
Convert some characters to HTML entities:
$str = "Jane & 'Tarzan'";
echo htmlentities($str, ENT_COMPAT); // Will only convert double quotes
echo "<br>";
echo htmlentities($str, ENT_QUOTES); // Converts double and single quotes
echo "<br>";
echo htmlentities($str, ENT_NOQUOTES); // Does not convert any quotes
?>
The HTML output of the code above will be (View Source):
<html>
<body>
Jane & 'Tarzan'<br>
Jane & 'Tarzan'<br>
Jane & 'Tarzan'
</body>
</html>
The browser output of the code above will be:
Jane & 'Tarzan'
Jane & 'Tarzan'
Example 2
Convert some characters to HTML entities using the Western European character-set:
$str = "My name is Øyvind Åsane. I'm Norwegian.";
echo htmlentities($str, ENT_QUOTES, "ISO-8859-1"); // Will only convert double quotes (not single quotes), and uses the character-set Western European
?>
The HTML output of the code above will be (View Source):
<html>
<body>
My name is Øyvind Åsane. I'm Norwegian.
</body>
</html>
The browser output of the code above will be:
PHP String Reference
