htmlspecialchars
Convert special characters to HTML entities
&reftitle.description;
stringhtmlspecialchars
stringstring
intflagsENT_COMPAT
stringcharset
booldouble_encodetrue
Certain characters have special significance in HTML, and should
be represented by HTML entities if they are to preserve their
meanings. This function returns a string with some of these
conversions made; the translations made are those most
useful for everyday web programming. If you require all HTML
character entities to be translated, use
htmlentities instead.
This function is useful in preventing user-supplied text from
containing HTML markup, such as in a message board or guest book
application.
The translations performed are:
'&' (ampersand) becomes '&'
'"' (double quote) becomes '"' when ENT_NOQUOTES
is not set.
''' (single quote) becomes ''' only when
ENT_QUOTES is set.
'<' (less than) becomes '<'
'>' (greater than) becomes '>'
&reftitle.parameters;
string
The string being converted.
flags
The optional second argument, flags, tells
the function what to do with single and double quote characters and with
invalid multi-byte sequences.
The default mode, ENT_COMPAT, is the backwards compatible mode
which only translates the double-quote character and leaves the
single-quote untranslated. If ENT_QUOTES is set, both single and
double quotes are translated and if ENT_NOQUOTES is set neither
single nor double quotes are translated.
In addition, since 5.3.0, these constants can be combined with
ENT_IGNORE. In that case, strings that contain invalid code unit
sequences have those invalid sequences discarded instead of having the function
return an empty string.
charset
Defines character set used in conversion.
The default character set is ISO-8859-1.
For the purposes of this function, the charsets
ISO-8859-1, ISO-8859-15,
UTF-8, cp866,
cp1251, cp1252, and
KOI8-R are effectively equivalent, as the
characters affected by htmlspecialchars
occupy the same positions in all of these charsets.
&reference.strings.charsets;
double_encode
When double_encode is turned off PHP will not
encode existing html entities, the default is to convert everything.
&reftitle.returnvalues;
The converted string.
&reftitle.changelog;
&Version;
&Description;
5.2.3
The double_encode parameter was added.
4.1.0
The charset parameter was added.
&reftitle.examples;
htmlspecialchars example
Test", ENT_QUOTES);
echo $new; // <a href='test'>Test</a>
?>
]]>
&reftitle.notes;
Note that this function does not translate anything beyond what
is listed above. For full entity translation, see
htmlentities.
&reftitle.seealso;
get_html_translation_table
htmlspecialchars_decode
strip_tags
htmlentities
nl2br