php man page for htmlspecialchars_decode

HTMLSPECIALCHARS_DECODE(3)						 1						HTMLSPECIALCHARS_DECODE(3)

htmlspecialchars_decode - Convert special HTML entities back to characters

SYNOPSIS
       string htmlspecialchars_decode (string  $string, [int  $flags = ENT_COMPAT | ENT_HTML401])

DESCRIPTION
	This function is the opposite of htmlspecialchars(3). It converts special HTML entities back to characters.

	The converted entities are: &, " (when ENT_NOQUOTES is not set), ' (when ENT_QUOTES is set), < and >.

PARAMETERS
	      o $string
		- The string to decode.

	      o $flags
		-  A bitmask of one or more of the following flags, which specify how to handle quotes and which document type to use. The default
		is ENT_COMPAT | ENT_HTML401.

	      Available $flags constants

	      +--------------+---------------------------------------------------+
	      |Constant Name |							 |
	      | 	     |							 |
	      | 	     |			  Description			 |
	      | 	     |							 |
	      +--------------+---------------------------------------------------+
	      | 	     |							 |
	      | ENT_COMPAT   |							 |
	      | 	     |							 |
	      | 	     | Will  convert  double-quotes  and  leave  single- |
	      | 	     | quotes alone.					 |
	      | 	     |							 |
	      | 	     |							 |
	      | ENT_QUOTES   |							 |
	      | 	     |							 |
	      | 	     |	  Will convert both double and single quotes.	 |
	      | 	     |							 |
	      | 	     |							 |
	      |ENT_NOQUOTES  |							 |
	      | 	     |							 |
	      | 	     | Will  leave  both double and single quotes uncon- |
	      | 	     | verted.						 |
	      | 	     |							 |
	      | 	     |							 |
	      | ENT_HTML401  |							 |
	      | 	     |							 |
	      | 	     |		   Handle code as HTML 4.01.		 |
	      | 	     |							 |
	      | 	     |							 |
	      |  ENT_XML1    |							 |
	      | 	     |							 |
	      | 	     |		     Handle code as XML 1.		 |
	      | 	     |							 |
	      | 	     |							 |
	      |  ENT_XHTML   |							 |
	      | 	     |							 |
	      | 	     |		     Handle code as XHTML.		 |
	      | 	     |							 |
	      | 	     |							 |
	      |  ENT_HTML5   |							 |
	      | 	     |							 |
	      | 	     |		     Handle code as HTML 5.		 |
	      | 	     |							 |
	      +--------------+---------------------------------------------------+
RETURN VALUES
	Returns the decoded string.

CHANGELOG
       +--------+---------------------------------------------------+
       |Version |						    |
       |	|						    |
       |	|		     Description		    |
       |	|						    |
       +--------+---------------------------------------------------+
       | 5.4.0	|						    |
       |	|						    |
       |	|  The constants ENT_HTML401,  ENT_XML1,  ENT_XHTML |
       |	| and ENT_HTML5 were added.			    |
       |	|						    |
       +--------+---------------------------------------------------+
EXAMPLES
       Example #1

	      A htmlspecialchars_decode(3) example

	      <?php
	      $str = "<p>this -&gt; &quot;</p>
";

	      echo htmlspecialchars_decode($str);

	      // note that here the quotes aren't converted
	      echo htmlspecialchars_decode($str, ENT_NOQUOTES);
	      ?>

	      The above example will output:

	      <p>this -> "</p>
	      <p>this -> &quot;</p>

SEE ALSO
       htmlspecialchars(3), html_entity_decode(3), get_html_translation_table(3).

PHP Documentation Group 												HTMLSPECIALCHARS_DECODE(3)