API15

API15:JURI/setVar

From Joomla! Documentation

Revision as of 18:56, 12 May 2013 by JoomlaWikiBot (talk | contribs) (removing red link to edit, no existant pages)

Description

Adds a query variable and value, replacing the value if it already exists and returning the old value.

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

Syntax

setVar($name, $value)
Parameter Name Default Value Description
$name $name Name of the query variable to set
$value $value Value of the query variable

Returns

string Previous value for the query variable

Defined in

libraries/joomla/environment/uri.php

Importing

jimport( 'joomla.environment.uri' );

Source Body

function setVar($name, $value)
{
        $tmp = @$this->_vars[$name];
        $this->_vars[$name] = $value;

        //empty the query
        $this->_query = null;

        return $tmp;
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />