output_add_rewrite_var

(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)

output_add_rewrite_var — Add URL rewriter values

Description

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

This function starts the 'URL-Rewriter' output buffer handler if it is not active, stores the name and value parameters, and when the buffer is flushed rewrites the URLs and forms based on the applicable ini settings. Subsequent calls to this function will store all additional name/value pairs until the handler is turned off.

When the output buffer is flushed (by calling ob_flush(), ob_end_flush(), ob_get_flush() or at the end of the script) the 'URL-Rewriter' handler adds the name/value pairs as query parameters to URLs in attributes of HTML tags and adds hidden fields to forms based on the values of the url_rewriter.tags and url_rewriter.hosts configuration directives.

Each name/value pair added to the 'URL-Rewriter' handler is added to the URLs and/or forms even if this results in duplicate URL query parameters or elements with the same name attributes.

Note: Once the 'URL-Rewriter' handler has been turned off it cannot be started again.

Warning

Prior to PHP 8.4.0, the hosts to be rewritten were set in session.trans_sid_hosts instead of url_rewriter.hosts.

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	As of PHP 7.1.0, a dedicated output buffer is used, url_rewriter.tags is used solely for output functions and url_rewriter.hosts is available. Prior to PHP 7.1.0, rewrite variables set by output_add_rewrite_var() shared an output buffer with transparent session id support (see session.trans_sid_tags).

Examples

Example #1 output_add_rewrite_var() example

<?php
ini_set('url_rewriter.tags', 'a=href,form=');

output_add_rewrite_var('var', 'value');

// some links
echo '<a href="/?originalUrl=https%3A%2F%2Fwww.php.net%2Ffile.php">link</a>
<a href="/?originalUrl=http%3A%2F%2Fexample.com%2F">link2</a>';

// a form
echo '<form action="/?originalUrl=https%3A%2F%2Fwww.php.net%2Fscript.php" method="post">
<input type="text" name="var2" />
</form>';

print_r(ob_list_handlers());
?>

The above example will output:

<a href="/?originalUrl=https%3A%2F%2Fwww.php.net%2F%26quot%3Bfile.php%3Fvar%3Dvalue%26quot%3B%26gt%3Blink%26lt%3B%2Fa%26gt%3B%26lt%3Ba%2520href%3D%26quot%3Bhttp%3A%2F%2Fexample.com%26quot%3B%26gt%3Blink2%26lt%3B%2Fa%26gt%3B%26lt%3Bform%2520action%3D%26quot%3Bscript.php%26quot%3B%2520method%3D%26quot%3Bpost%26quot%3B%26gt%3B%26lt%3Binput%2520type%3D%26quot%3Bhidden%26quot%3B%2520name%3D%26quot%3Bvar%26quot%3B%2520value%3D%26quot%3Bvalue%26quot%3B%2520%2F%26gt%3B%26lt%3Binput%2520type%3D%26quot%3Btext%26quot%3B%2520name%3D%26quot%3Bvar2%26quot%3B%2520%2F%26gt%3B%26lt%3B%2Fform%26gt%3BArray(%2520%2520%2520%2520%5B0%5D%2520%3D%26gt%3B%2520URL-Rewriter)%253C%2Fpre">

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 2 notes

down

Niko ¶

17 years ago

This function also adds a parameter to <input type="image"> fields!

Example:
This code:

<?
output_add_rewrite_var ('var','value');
echo '<form action="" method="post">
        <input type="image" src="/?originalUrl=https%3A%2F%2Fwww.php.net%2Fimage.jpg" alt="go">
        </form>';
?>

will output something like this:

<form action="" method="post">
        <input type="hidden" name="var" value="value">
        <input type="image" src="/?originalUrl=https%3A%2F%2Fwww.php.net%2Fimage.jpg%3Fvar%3Dvalue" alt="go">
        </form>