php man page for output_add_rewrite_var

OUTPUT_ADD_REWRITE_VAR(3)						 1						 OUTPUT_ADD_REWRITE_VAR(3)

output_add_rewrite_var - Add URL rewriter values

SYNOPSIS
       bool output_add_rewrite_var (string  $name, string  $value)

DESCRIPTION
	This  function	adds another name/value pair to the URL rewrite mechanism. The name and value will be added to URLs (as GET parameter) and
       forms (as hidden input fields) the same way as the session ID when transparent URL rewriting is enabled with session.use_trans_sid.  Please
       note that absolute URLs (http://example.com/..) aren't rewritten.

	This function's behavior is controlled by the url_rewriter.tags php.ini parameter.

       Note

	       Calling this function will implicitly start output buffering if it is not active already.

PARAMETERS
	      o $name
		- The variable name.

	      o $value
		- The variable value.

RETURN VALUES
	Returns TRUE on success or FALSE on failure.

EXAMPLES
       Example #1

	      output_add_rewrite_var(3) example

	      <?php
	      output_add_rewrite_var('var', 'value');

	      // some links
	      echo '<a href="file.php">link</a>
	      <a href="http://example.com">link2</a>';

	      // a form
	      echo '<form action="script.php" method="post">
	      <input type="text" name="var2" />
	      </form>';

	      print_r(ob_list_handlers());
	      ?>

	      The above example will output:

	      <a href="file.php?var=value">link</a>
	      <a href="http://example.com">link2</a>

	      <form action="script.php" method="post">
	      <input type="hidden" name="var" value="value" />
	      <input type="text" name="var2" />
	      </form>

	      Array
	      (
		  [0] => URL-Rewriter
	      )

SEE ALSO
       output_reset_rewrite_vars(3), ob_flush(3), ob_list_handlers(3).

PHP Documentation Group 												 OUTPUT_ADD_REWRITE_VAR(3)