get_html_translation_table
(PHP 4, PHP 5)
get_html_translation_table — Returns the translation table used by htmlspecialchars() and htmlentities()
Description
get_html_translation_table() will return the translation table that is used internally for htmlspecialchars() and htmlentities() with the default charset.
Note:
Special characters can be encoded in several ways. E.g. " can be encoded as ", " or ". get_html_translation_table() returns only the most common form for them.
Parameters
- table
-
There are two new constants (HTML_ENTITIES, HTML_SPECIALCHARS) that allow you to specify the table you want.
- quote_style
-
Like the htmlspecialchars() and htmlentities() functions you can optionally specify the quote_style you are working with. See the description of these modes in htmlspecialchars().
- charset_hint
-
Like htmlentities(), it takes an optional third argument charset which defines character set used in conversion. Presently, the ISO-8859-1 character set is used as the default.
Following character sets are supported in PHP 4.3.0 and later.
Supported charsets Charset Aliases Description ISO-8859-1 ISO8859-1 Western European, Latin-1 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. This charset is supported in 4.3.2. cp1251 Windows-1251, win-1251, 1251 Windows-specific Cyrillic charset. This charset is supported in 4.3.2. cp1252 Windows-1252, 1252 Windows specific charset for Western European. KOI8-R koi8-ru, koi8r Russian. This charset is supported in 4.3.2. 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, 932 Japanese EUC-JP EUCJP Japanese Note: Any other character sets are not recognized and ISO-8859-1 will be used instead.
Return Values
Returns the translation table as an array.
Changelog
| Version | Description |
|---|---|
| 5.3.4 | The charset_hint parameter was added. |
Examples
Example #1 Translation Table Example
<?php
$trans = get_html_translation_table(HTML_ENTITIES);
$str = "Hallo & <Frau> & Krämer";
$encoded = strtr($str, $trans);
echo $encoded;
?>
The above example will output:
Hallo & <Frau> & Krämer
See Also
- htmlspecialchars() - Convert special characters to HTML entities
- htmlentities() - Convert all applicable characters to HTML entities
- html_entity_decode() - Convert all HTML entities to their applicable characters