PHP get_html_translation_table() Function
Topic: PHP String ReferencePrev|Next
Description
The get_html_translation_table() function returns the translation table used by the htmlspecialchars() and htmlentities() functions.
The following table summarizes the technical details of this function.
| Return Value: |
Returns the translation table as an array, with the original characters as keys and entities as values. |
| Version: |
PHP 4+ |
Syntax
The basic syntax of the get_html_translation_table() function is given with:
get_html_translation_table(table, flags, charset);
The following example shows the get_html_translation_table() function in action.
<?php
// Getting translation table
$arr = get_html_translation_table(); // HTML_SPECIALCHARS is default
print_r($arr);
?>
The output of the above example will look something like this (view source):
Array
(
["] => "
[&] => &
[<] => <
[>] => >
)
Note: Some characters can be encoded in several ways, for example, " (double quote) can be encoded as ", " or ". The get_html_translation_table() function only returns the form used by the htmlspecialchars() and htmlentities().
Parameters
The get_html_translation_table() function accepts the following parameters.
| Parameter |
Description |
| table |
Optional. Specifies which translation table to return. Either HTML_ENTITIES or HTML_SPECIALCHARS. Default is HTML_SPECIALCHARS. |
| flags |
Optional. Specifies which quotes the table will contain as well as which document type the table is for. You can specify one or more of the following flags.
The available flags constants for handling quotes are:
- 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 not contain entities for both single and double quotes.
The available flags constants for specifying the document types are:
- ENT_HTML401 – Table for HTML 4.01.
- ENT_HTML5 – Table for HTML 5.
- ENT_XML1 – Table for XML 1.
- ENT_XHTML – Table for XHTML.
The default value for this parameter is ENT_COMPAT | ENT_HTML401.
|
| charset |
Optional. Specifies which character set to use. Supported charsets are:
- UTF-8 – Default. ASCII compatible multi-byte 8-bit Unicode.
- ISO-8859-1 – Western European, Latin-1.
- ISO-8859-5 – Little used cyrillic charset (Latin/Cyrillic).
- ISO-8859-15 Western European, Latin-9. Adds the Euro sign, French and Finnish letters missing in Latin-1 (ISO-8859-1).
- cp866 – DOS-specific Cyrillic charset.
- cp1251 – Windows-specific Cyrillic charset.
- cp1252 – Windows specific charset for Western European.
- KOI8-R – Russian.
- BIG5 – Traditional Chinese, mainly used in Taiwan.
- GB2312 – Simplified Chinese, national standard character set.
- BIG5-HKSCS – Big5 with Hong Kong extensions, Traditional Chinese.
- Shift_JIS – Japanese.
- EUC-JP – Japanese.
- MacRoman – Charset that was used by Mac OS.
Note: Any other character sets are not recognized. The default character set UTF-8 will be used in that situation and a warning will be generated.
|
More Examples
Here're some more examples showing how get_html_translation_table() function actually works:
The following example returns the translation table used by the htmlentities() function. View source (right-click and select View Page Source) of the example output to see the raw data.
<?php
// Getting translation table
$arr = get_html_translation_table(HTML_ENTITIES);
print_r($arr);
?>
The output of the above example will look something like this (view source):
Array
(
["] => "
[&] => &
[<] => <
[>] => >
[ ] =>
[¡] => ¡
[¢] => ¢
[£] => £
[¤] => ¤
[¥] => ¥
[¦] => ¦
[§] => §
[¨] => ¨
[©] => ©
[ª] => ª
[«] => «
[¬] => ¬
[] => ­
[®] => ®
[¯] => ¯
[°] => °
[±] => ±
[²] => ²
[³] => ³
[´] => ´
[µ] => µ
[¶] => ¶
[·] => ·
[¸] => ¸
[¹] => ¹
[º] => º
[»] => »
[¼] => ¼
[½] => ½
[¾] => ¾
[¿] => ¿
[À] => À
[Á] => Á
[Â] => Â
[Ã] => Ã
[Ä] => Ä
[Å] => Å
[Æ] => Æ
[Ç] => Ç
[È] => È
[É] => É
[Ê] => Ê
[Ë] => Ë
[Ì] => Ì
[Í] => Í
[Î] => Î
[Ï] => Ï
[Ð] => Ð
[Ñ] => Ñ
[Ò] => Ò
[Ó] => Ó
[Ô] => Ô
[Õ] => Õ
[Ö] => Ö
[×] => ×
[Ø] => Ø
[Ù] => Ù
[Ú] => Ú
[Û] => Û
[Ü] => Ü
[Ý] => Ý
[Þ] => Þ
[ß] => ß
[à] => à
[á] => á
[â] => â
[ã] => ã
[ä] => ä
[å] => å
[æ] => æ
[ç] => ç
[è] => è
[é] => é
[ê] => ê
[ë] => ë
[ì] => ì
[í] => í
[î] => î
[ï] => ï
[ð] => ð
[ñ] => ñ
[ò] => ò
[ó] => ó
[ô] => ô
[õ] => õ
[ö] => ö
[÷] => ÷
[ø] => ø
[ù] => ù
[ú] => ú
[û] => û
[ü] => ü
[ý] => ý
[þ] => þ
[ÿ] => ÿ
[Œ] => Œ
[œ] => œ
[Š] => Š
[š] => š
[Ÿ] => Ÿ
[ƒ] => ƒ
[ˆ] => ˆ
[˜] => ˜
[Α] => Α
[Β] => Β
[Γ] => Γ
[Δ] => Δ
[Ε] => Ε
[Ζ] => Ζ
[Η] => Η
[Θ] => Θ
[Ι] => Ι
[Κ] => Κ
[Λ] => Λ
[Μ] => Μ
[Ν] => Ν
[Ξ] => Ξ
[Ο] => Ο
[Π] => Π
[Ρ] => Ρ
[Σ] => Σ
[Τ] => Τ
[Υ] => Υ
[Φ] => Φ
[Χ] => Χ
[Ψ] => Ψ
[Ω] => Ω
[α] => α
[β] => β
[γ] => γ
[δ] => δ
[ε] => ε
[ζ] => ζ
[η] => η
[θ] => θ
[ι] => ι
[κ] => κ
[λ] => λ
[μ] => μ
[ν] => ν
[ξ] => ξ
[ο] => ο
[π] => π
[ρ] => ρ
[ς] => ς
[σ] => σ
[τ] => τ
[υ] => υ
[φ] => φ
[χ] => χ
[ψ] => ψ
[ω] => ω
[ϑ] => ϑ
[ϒ] => ϒ
[ϖ] => ϖ
[ ] =>  
[ ] =>  
[ ] =>  
[] => ‌
[] => ‍
[] => ‎
[] => ‏
[–] => –
[—] => —
[‘] => ‘
[’] => ’
[‚] => ‚
[“] => “
[”] => ”
[„] => „
[†] => †
[‡] => ‡
[•] => •
[…] => …
[‰] => ‰
[′] => ′
[″] => ″
[‹] => ‹
[›] => ›
[‾] => ‾
[⁄] => ⁄
[€] => €
[ℑ] => ℑ
[℘] => ℘
[ℜ] => ℜ
[™] => ™
[ℵ] => ℵ
[←] => ←
[↑] => ↑
[→] => →
[↓] => ↓
[↔] => ↔
[↵] => ↵
[⇐] => ⇐
[⇑] => ⇑
[⇒] => ⇒
[⇓] => ⇓
[⇔] => ⇔
[∀] => ∀
[∂] => ∂
[∃] => ∃
[∅] => ∅
[∇] => ∇
[∈] => ∈
[∉] => ∉
[∋] => ∋
[∏] => ∏
[∑] => ∑
[−] => −
[∗] => ∗
[√] => √
[∝] => ∝
[∞] => ∞
[∠] => ∠
[∧] => ∧
[∨] => ∨
[∩] => ∩
[∪] => ∪
[∫] => ∫
[∴] => ∴
[∼] => ∼
[≅] => ≅
[≈] => ≈
[≠] => ≠
[≡] => ≡
[≤] => ≤
[≥] => ≥
[⊂] => ⊂
[⊃] => ⊃
[⊄] => ⊄
[⊆] => ⊆
[⊇] => ⊇
[⊕] => ⊕
[⊗] => ⊗
[⊥] => ⊥
[⋅] => ⋅
[⌈] => ⌈
[⌉] => ⌉
[⌊] => ⌊
[⌋] => ⌋
[⟨] => ⟨
[⟩] => ⟩
[◊] => ◊
[♠] => ♠
[♣] => ♣
[♥] => ♥
[♦] => ♦
)
