PHP Tutorial - PHP get_html_translation_table() Function
Definition
The get_html_translation_table() function returns the translation table used by the htmlentities() and htmlspecialchars() functions.
Syntax
PHP get_html_translation_table() Function has the following syntax.
array get_html_translation_table ([ int $table = HTML_SPECIALCHARS [, int $flags = ENT_COMPAT | ENT_HTML401 [, string $encoding = 'UTF-8' ]]] )Parameter
- table - Which table to return. Either HTML_ENTITIES or HTML_SPECIALCHARS.
- flags - A bitmask of one or more of the following flags, which specify which quotes the table will contain as well as which document type the table is for. The default is ENT_COMPAT | ENT_HTML401.
- encoding - Encoding to use. If omitted, the default value for this argument is ISO-8859-1 in versions of PHP prior to 5.4.0, and UTF-8 from PHP 5.4.0 onwards.
Available constants for flags
| Constant Name | Description |
|---|---|
| ENT_COMPAT | Table will contain entities for double-quotes, but not for single-quotes. |
| ENT_QUOTES | Table will contain entities for both double and single quotes. |
| ENT_NOQUOTES | Table will neither contain entities for single quotes nor for double quotes. |
| ENT_HTML401 | Table for HTML 4.01. |
| ENT_XML1 | Table for XML 1. |
| ENT_XHTML | Table for XHTML. |
| ENT_HTML5 | Table for HTML 5. |
The following character sets are supported:
| 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 | No Alias | 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 | No Alias | Big5 with Hong Kong extensions, Traditional Chinese. |
| Shift_JIS | SJIS, SJIS-win, cp932, 932 | Japanese |
| EUC-JP | EUCJP, eucJP-win | Japanese |
| MacRoman | No Alias | Charset that was used by Mac OS. |
| '' | No Alias | 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. |
Any other character sets are not recognized. The default encoding will be used instead and a warning will be emitted.
Return
PHP get_html_translation_table() Function returns the translation table as an array, with the original characters as keys and entities as values.
Example 1
Print the translation table used by the htmlspecialchars function:
<?php
print_r (get_html_translation_table()); // HTML_SPECIALCHARS is default.
?>
The code above generates the following result.
Example 2
Table for HTML_SPECIALCHARS:
<?php
print_r (get_html_translation_table(HTML_SPECIALCHARS));
?>
The code above generates the following result.
Example 3
Table for HTML_ENTITIES:
<?php
print_r (get_html_translation_table(HTML_ENTITIES));
?>
The code above generates the following result.
