Latest web development tutorials
 

PHP get_html_translation_table() Function

< PHP String Reference

Example

Print the translation table used by the htmlspecialchars function:

<?php
print_r (get_html_translation_table()); // HTML_SPECIALCHARS is default.
?>
Run example »

Definition and Usage

The get_html_translation_table() function returns the translation table used by the htmlentities() and htmlspecialchars() functions.

Tip: Some characters can be encoded several ways. The get_html_translation_table() function returns the most common encoding.

Syntax

get_html_translation_table(function,flags,character-set)

Parameter Description
function Optional. Specifies which translation table to return.

Possible values:

  • HTML_SPECIALCHARS - Default. Translates some characters that need URL-encoding to be shown properly on a HTML page
  • HTML_ENTITIES - Translates all characters that need URL-encoding to be shown properly on a HTML page
flags Optional. Specifies which quotes the table will contain and which document type the table is for.

The available quote styles are:

  • ENT_COMPAT - Default. Table contains entities for double quotes, not single quotes
  • ENT_QUOTES - Table contains entities for double and single quotes
  • ENT_NOQUOTES - Table will not contain entities for double and single quotes

Additional flags for specifying which doctype the table is for:

  • ENT_HTML401 - Default. Table for HTML 4.01
  • ENT_HTML5 - Table for HTML 5
  • ENT_XML1 - Table for XML 1
  • ENT_XHTML - Table for XHTML
character-set Optional. A string that specifies which character-set to use.

Allowed values are:

  • UTF-8 - Default. ASCII compatible multi-byte 8-bit Unicode
  • ISO-8859-1 - Western European
  • ISO-8859-15 - Western European (adds the Euro sign + French and Finnish letters missing in 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
  • Shift_JIS - Japanese
  • EUC-JP - Japanese
  • MacRoman - Character-set that was used by Mac OS

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.

Technical Details

Return Value: Returns the translation table as an array, with the original characters as keys and entities as values
PHP Version: 4+
Changelog: The default value for the character-set parameter was changed to UTF-8 in PHP 5

The additional flags for specifying which doctype the table is for; ENT_HTML401, ENT_HTML5, ENT_XML1 and ENT_XHTML were added in PHP 5.4

The character-set parameter was added in PHP 5.3.4

More Examples

Example

Table for HTML_SPECIALCHARS:

<?php
print_r (get_html_translation_table(HTML_SPECIALCHARS));
?>

Displaying character and entity name:

Array
(
  ["] => &quot;
  [&] => &amp;
  [<] => &lt;
  [>] => &gt;
)


Example 2

Table for HTML_ENTITIES:

<?php
print_r (get_html_translation_table(HTML_ENTITIES));
?>

Displaying character and entity name:

Array
(
  ["] => &quot;
  [&] => &amp;
  [<] => &lt;
  [>] => &gt;
  [ ] => &nbsp;
  [] => &iexcl;
  [] => &cent;
  [] => &pound;
  [] => &curren;
  [] => &yen;
  [] => &brvbar;
  [] => &sect;
  [] => &uml;
  [] => &copy;
  [] => &ordf;
  [] => &laquo;
  [] => &not;
  [] => &shy;
  [] => &reg;
  [] => &macr;
  [] => &deg;
  [] => &plusmn;
  [] => &sup2;
  [] => &sup3;
  [] => &acute;
  [] => &micro;
  [] => &para;
  [] => &middot;
  [] => &cedil;
  [] => &sup1;
  [] => &ordm;
  [] => &raquo;
  [] => &frac14;
  [] => &frac12;
  [] => &frac34;
  [] => &iquest;
  [] => &Agrave;
  [] => &Aacute;
  [] => &Acirc;
  [] => &Atilde;
  [] => &Auml;
  [] => &Aring;
  [] => &AElig;
  [] => &Ccedil;
  [] => &Egrave;
  [] => &Eacute;
  [] => &Ecirc;
  [] => &Euml;
  [] => &Igrave;
  [] => &Iacute;
  [] => &Icirc;
  [] => &Iuml;
  [] => &ETH;
  [] => &Ntilde;
  [] => &Ograve;
  [] => &Oacute;
  [] => &Ocirc;
  [] => &Otilde;
  [] => &Ouml;
  [] => &times;
  [] => &Oslash;
  [] => &Ugrave;
  [] => &Uacute;
  [] => &Ucirc;
  [] => &Uuml;
  [] => &Yacute;
  [] => &THORN;
  [] => &szlig;
  [] => &agrave;
  [] => &aacute;
  [] => &acirc;
  [] => &atilde;
  [] => &auml;
  [] => &aring;
  [] => &aelig;
  [] => &ccedil;
  [] => &egrave;
  [] => &eacute;
  [] => &ecirc;
  [] => &euml;
  [] => &igrave;
  [] => &iacute;
  [] => &icirc;
  [] => &iuml;
  [] => &eth;
  [] => &ntilde;
  [] => &ograve;
  [] => &oacute;
  [] => &ocirc;
  [] => &otilde;
  [] => &ouml;
  [] => &divide;
  [] => &oslash;
  [] => &ugrave;
  [] => &uacute;
  [] => &ucirc;
  [] => &uuml;
  [] => &yacute;
  [] => &thorn;
  [] => &yuml;
  [] => &OElig;
  [] => &oelig;
  [] => &Scaron;
  [] => &scaron;
  [] => &Yuml;
  [] => &fnof;
  [] => &circ;
  [] => &tilde;
  [Α] => &Alpha;
  [Β] => &Beta;
  [Γ] => &Gamma;
  [Δ] => &Delta;
  [Ε] => &Epsilon;
  [Ζ] => &Zeta;
  [Η] => &Eta;
  [Θ] => &Theta;
  [Ι] => &Iota;
  [Κ] => &Kappa;
  [Λ] => &Lambda;
  [Μ] => &Mu;
  [Ν] => &Nu;
  [Ξ] => &Xi;
  [Ο] => &Omicron;
  [Π] => &Pi;
  [Ρ] => &Rho;
  [Σ] => &Sigma;
  [Τ] => &Tau;
  [Υ] => &Upsilon;
  [Φ] => &Phi;
  [Χ] => &Chi;
  [Ψ] => &Psi;
  [Ω] => &Omega;
  [α] => &alpha;
  [β] => &beta;
  [γ] => &gamma;
  [δ] => &delta;
  [ε] => &epsilon;
  [ζ] => &zeta;
  [η] => &eta;
  [θ] => &theta;
  [ι] => &iota;
  [κ] => &kappa;
  [λ] => &lambda;
  [μ] => &mu;
  [ν] => &nu;
  [ξ] => &xi;
  [ο] => &omicron;
  [π] => &pi;
  [ρ] => &rho;
  [ς] => &sigmaf;
  [σ] => &sigma;
  [τ] => &tau;
  [υ] => &upsilon;
  [φ] => &phi;
  [χ] => &chi;
  [ψ] => &psi;
  [ω] => &omega;
  [ϑ] => &thetasym;
  [ϒ] => &upsih;
  [ϖ] => &piv;
  [ ] => &ensp;
  [ ] => &emsp;
  [ ] => &thinsp;
  [‌] => &zwnj;
  [‍] => &zwj;
  [‎] => &lrm;
  [‏] => &rlm;
  [] => &ndash;
  [] => &mdash;
  [] => &lsquo;
  [] => &rsquo;
  [] => &sbquo;
  [] => &ldquo;
  [] => &rdquo;
  [] => &bdquo;
  [] => &dagger;
  [] => &Dagger;
  [] => &bull;
  [] => &hellip;
  [] => &permil;
  [′] => &prime;
  [″] => &Prime;
  [] => &lsaquo;
  [] => &rsaquo;
  [‾] => &oline;
  [⁄] => &frasl;
  [] => &euro;
  [ℑ] => &image;
  [℘] => &weierp;
  [ℜ] => &real;
  [] => &trade;
  [ℵ] => &alefsym;
  [←] => &larr;
  [↑] => &uarr;
  [→] => &rarr;
  [↓] => &darr;
  [↔] => &harr;
  [↵] => &crarr;
  [⇐] => &lArr;
  [⇑] => &uArr;
  [⇒] => &rArr;
  [⇓] => &dArr;
  [⇔] => &hArr;
  [∀] => &forall;
  [∂] => &part;
  [∃] => &exist;
  [∅] => &empty;
  [∇] => &nabla;
  [∈] => &isin;
  [∉] => &notin;
  [∋] => &ni;
  [∏] => &prod;
  [∑] => &sum;
  [−] => &minus;
  [∗] => &lowast;
  [√] => &radic;
  [∝] => &prop;
  [∞] => &infin;
  [∠] => &ang;
  [∧] => &and;
  [∨] => &or;
  [∩] => &cap;
  [∪] => &cup;
  [∫] => &int;
  [∴] => &there4;
  [∼] => &sim;
  [≅] => &cong;
  [≈] => &asymp;
  [≠] => &ne;
  [≡] => &equiv;
  [≤] => &le;
  [≥] => &ge;
  [⊂] => &sub;
  [⊃] => &sup;
  [⊄] => &nsub;
  [⊆] => &sube;
  [⊇] => &supe;
  [⊕] => &oplus;
  [⊗] => &otimes;
  [⊥] => &perp;
  [⋅] => &sdot;
  [⌈] => &lceil;
  [⌉] => &rceil;
  [⌊] => &lfloor;
  [⌋] => &rfloor;
  [〈] => &lang;
  [〉] => &rang;
  [◊] => &loz;
  [♠] => &spades;
  [♣] => &clubs;
  [♥] => &hearts;
  [♦] => &diams;
)

< PHP String Reference