output_add_rewrite_var
output_add_rewrite_var
(PHP 4 >= 4.3.0, PHP 5, PHP 7)
output_add_rewrite_var — Add URL rewriter values
Description
bool output_add_rewrite_var ( string $name , string $value )
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.
This function's behaviour is controlled by the url_rewriter.tags and url_rewriter.hosts php.ini parameters.
Note: Calling this function will implicitly start output buffering if it is not active already.
Parameters
name
The variable name.
value
The variable value.
Return Values
Returns TRUE on success or FALSE on failure.
Changelog
| Version | Description |
|---|---|
| 7.1.0 | Before PHP 7.1.0, rewrite vars set by output_add_rewrite_var() use the same Session module trans sid output buffer. Since PHP 7.1.0, dedicated output buffer is used, url_rewriter.tags is used solely for output functions, url_rewriter.hosts is addedd. |
Examples
Example #1 output_add_rewrite_var() 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() - Reset URL rewriter values
- ob_flush() - Flush (send) the output buffer
- ob_list_handlers() - List all output handlers in use
← ob_start
output_reset_rewrite_vars →
© 1997–2017 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://secure.php.net/manual/en/function.output-add-rewrite-var.php
