output_add_rewrite_var

PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
output_add_rewrite_var - Add URL rewriter values
Manual
Code Examples

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

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 that this function can be successfully called at most once per request.

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 added.

Related Functions

Example of output_add_rewrite_var

Show all examples for output_add_rewrite_var

PHP Version:


Function output_add_rewrite_var:

Output Buffering Control Functions

Most used PHP functions