File: function.htmlspecialchars.html

package info (click to toggle)
php3 3%3A3.0.18-0potato1.1
links: PTS
area: main
in suites: potato
size: 17,736 kB
ctags: 11,198
sloc: ansic: 108,120; sh: 2,512; php: 2,024; yacc: 1,887; makefile: 1,038; perl: 537; pascal: 238; awk: 90; cpp: 28; sql: 11
file content (296 lines) | stat: -rw-r--r-- 4,792 bytes
parent folder | download | duplicates (3)
<HTML
><HEAD
><TITLE
>htmlspecialchars</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.57"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="manual.html"><LINK
REL="UP"
TITLE="String functions"
HREF="ref.strings.html"><LINK
REL="PREVIOUS"
TITLE="htmlentities"
HREF="function.htmlentities.html"><LINK
REL="NEXT"
TITLE="implode"
HREF="function.implode.html"><META
NAME="HTTP_EQUIV"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.htmlentities.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.implode.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.htmlspecialchars"
>htmlspecialchars</A
></H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN36602"
></A
><P
>    (PHP3 , PHP4 )</P
>htmlspecialchars&nbsp;--&nbsp;
     Convert special characters to HTML entities
    </DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN36605"
></A
><H2
>Description</H2
><DIV
CLASS="funcsynopsis"
><A
NAME="AEN36607"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>string <B
CLASS="function"
>htmlspecialchars</B
></CODE
> (string string [, int quote_style])</CODE
></P
><P
></P
></DIV
><P
>&#13;     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
     <A
HREF="function.htmlentities.html"
><B
CLASS="function"
>htmlentities()</B
></A
> instead.
    </P
><P
>&#13;     This function is useful in preventing user-supplied text from
     containing HTML markup, such as in a message board or guest book
     application.  The optional second argument, quote_style, tells the
	 function what to do with single and double quote characters.  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.
    </P
><P
>&#13;     The translations performed are:
     <P
></P
><UL
><LI
><P
>&#13;        '&#38;' (ampersand) becomes '&#38;amp;'
       </P
></LI
><LI
><P
>&#13;        '"' (double quote) becomes '&#38;quot;' when ENT_NOQUOTES is not set.
       </P
></LI
><LI
><P
>&#13;        ''' (single quote) becomes '&#38;#039;' only when ENT_QUOTES is set.
       </P
></LI
><LI
><P
>&#13;        '&#60;' (less than) becomes '&#38;lt;'
       </P
></LI
><LI
><P
>&#13;        '&#62;' (greater than) becomes '&#38;gt;'
       </P
></LI
></UL
>
     <TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN36631"
></A
><P
><B
>Example 1. <B
CLASS="function"
>htmlspecialchars()</B
> example</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="programlisting"
>&#13;$new = htmlspecialchars("&#60;a href='test'&#62;Test&#60;/a&#62;", ENT_QUOTES);
      </PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>
    </P
><P
>&#13;     Note that this function does not translate anything beyond what
     is listed above. For full entity translation, see
     <A
HREF="function.htmlentities.html"
><B
CLASS="function"
>htmlentities()</B
></A
>.  Also note that the optional second
	 argument was added in PHP 3.0.17 and PHP 4.0.3.
    </P
><P
>&#13;     See also <A
HREF="function.htmlentities.html"
><B
CLASS="function"
>htmlentities()</B
></A
> and
     <A
HREF="function.nl2br.html"
><B
CLASS="function"
>nl2br()</B
></A
>.
    </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.htmlentities.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="manual.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.implode.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>htmlentities</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.strings.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>implode</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>