Source of: /manual/en/function.output-add-rewrite-var.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.outcontrol.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.output-add-rewrite-var.php',
1 => 'output_add_rewrite_var',
),
'up' =>
array (
0 => 'ref.outcontrol.php',
1 => 'Output Control Functions',
),
'prev' =>
array (
0 => 'function.ob-start.php',
1 => 'ob_start',
),
'next' =>
array (
0 => 'function.output-reset-rewrite-vars.php',
1 => 'output_reset_rewrite_vars',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.output-add-rewrite-var" class="refentry">
<div class="refnamediv">
<h1 class="refname">output_add_rewrite_var</h1>
<p class="verinfo">(PHP 4 >= 4.3.0, PHP 5)</p><p class="refpurpose"><span class="refname">output_add_rewrite_var</span> — <span class="dc-title">Add URL rewriter values</span></p>
</div>
<a name="function.output-add-rewrite-var.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>output_add_rewrite_var</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$name</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$value</tt></span>
)</div>
<p class="para rdfs-comment">
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 <a href="session.configuration.php#ini.session.use-trans-sid" class="link">session.use_trans_sid</a>. Please
note that absolute URLs (http://example.com/..) aren't rewritten.
</p>
<p class="para">
This function's behavior is controlled by the <a href="session.configuration.php#ini.url-rewriter.tags" class="link">url_rewriter.tags</a> <var class="filename">php.ini</var>
parameter.
</p>
<blockquote><p><b class="note">Note</b>:
<span class="simpara">
Calling this function will implicitly start output buffering if it is
not active already.
</span>
</p></blockquote>
</div>
<a name="function.output-add-rewrite-var.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">name</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The variable name.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">value</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The variable value.
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.output-add-rewrite-var.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.output-add-rewrite-var.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>output_add_rewrite_var()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />output_add_rewrite_var</span><span style="color: #007700">(</span><span style="color: #DD0000">'var'</span><span style="color: #007700">, </span><span style="color: #DD0000">'value'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// some links<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">'<a href="file.php">link</a><br /><a href="http://example.com">link2</a>'</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// a form<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">'<form action="script.php" method="post"><br /><input type="text" name="var2" /><br /></form>'</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">ob_list_handlers</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents para"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
<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
)
</pre></div>
</div>
</div><p>
</p>
</div>
<a name="function.output-add-rewrite-var.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.output-reset-rewrite-vars.php" class="function" rel="rdfs-seeAlso">output_reset_rewrite_vars()</a> - Reset URL rewriter values</li>
<li class="member"><a href="function.ob-flush.php" class="function" rel="rdfs-seeAlso">ob_flush()</a> - Flush (send) the output buffer</li>
<li class="member"><a href="function.ob-list-handlers.php" class="function" rel="rdfs-seeAlso">ob_list_handlers()</a> - List all output handlers in use</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
