GET_HTML_TRANSLATION_TABLE(3) 1 GET_HTML_TRANSLATION_TABLE(3)
get_html_translation_table - Returns the translation table used byhtmlspecialchars(3)andhtmlentities(3)
SYNOPSIS
array get_html_translation_table ([int $table = HTML_SPECIALCHARS], [int $flags = ENT_COMPAT | ENT_HTML401], [string $encoding =
"UTF-8"])
DESCRIPTION
get_html_translation_table(3) will return the translation table that is used internally for htmlspecialchars(3) and htmlentities(3).
Note
Special characters can be encoded in several ways. E.g. " can be encoded as ", " or ". get_html_translation_table(3)
returns only the form used by htmlspecialchars(3) and htmlentities(3).
PARAMETERS
o $table
- Which table to return. Either HTML_ENTITIES or HTML_SPECIALCHARS.
o $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.
Available $flags constants
+--------------+---------------------------------------------------+
|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. |
| | |
+--------------+---------------------------------------------------+
o $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. The following character sets are supported:
Supported charsets
+------------+--------------------------------------+---+
| 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 let- | |
| | ters missing in Latin-1 | |
| | (ISO-8859-1). | |
| | | |
| UTF-8 | | |
| | | |
| | | |
| | |T{ | |
| | 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 West- | |
| | ern European. | |
| | | |
| KOI8-R | | |
| | | |
| | koi8-ru, koi8r | |
| | | |
| | Russian. | |
| | | |
| BIG5 | | |
| | | |
| | 950 | |
| | | |
| | Traditional Chinese, mainly used in | |
| | Taiwan. | |
| | | |
| GB2312 | | |
| | | |
| | 936 | |
| | | |
| | Simplified Chinese, national stan- | |
| | dard character set. | |
| | | |
|BIG5-HKSCS | | |
| | | |
| | | |
| | |T{ | |
| | Big5 with Hong Kong extensions, | |
| | Traditional Chinese. | |
| | | |
| Shift_JIS | | |
| | | |
| | SJIS, SJIS-win, cp932, 932 | |
| | | |
| | Japanese | |
| | | |
| EUC-JP | | |
| | | |
| | EUCJP, eucJP-win | |
| | | |
| | Japanese | |
| | | |
| MacRoman | | |
| | | |
| | | |
| | |T{ | |
| | Charset that was used by Mac OS. | |
| | | |
| | | |
| '' | | |
| | | |
| | | |
| | |T{ | |
| | An empty string activates detection | |
| | from script encoding (Zend multi- | |
| | byte), default_charset and current | |
| | locale (see nl_langinfo(3) and set- | |
| | locale(3)), in this order. Not rec- | |
| | ommended. | |
| | | |
+------------+--------------------------------------+---+
Note
Any other character sets are not recognized. The default encoding will be used instead and a warning will be emitted.
RETURN VALUES
Returns the translation table as an array, with the original characters as keys and entities as values.
CHANGELOG
+--------+---------------------------------------------------+
|Version | |
| | |
| | Description |
| | |
+--------+---------------------------------------------------+
| 5.4.0 | |
| | |
| | The default value for the $encoding parameter |
| | was changed to UTF-8. |
| | |
| 5.4.0 | |
| | |
| | The constants ENT_HTML401, ENT_XML1, ENT_XHTML |
| | and ENT_HTML5 were added. |
| | |
| 5.3.4 | |
| | |
| | The $encoding parameter was added. |
| | |
+--------+---------------------------------------------------+
EXAMPLES
Example #1
Translation Table Example
<?php
var_dump(get_html_translation_table(HTML_ENTITIES, ENT_QUOTES | ENT_HTML5));
?>
The above example will output something similar to:
array(1510) {
["
"]=>
string(9) "
"
["!"]=>
string(6) "!"
["""]=>
string(6) """
["#"]=>
string(5) "#"
["$"]=>
string(8) "$"
["%"]=>
string(8) "%"
["&"]=>
string(5) "&"
["'"]=>
string(6) "'"
// ...
}
SEE ALSO
htmlspecialchars(3), htmlentities(3), html_entity_decode(3).
PHP Documentation Group GET_HTML_TRANSLATION_TABLE(3)