API16

API16:JPagination/getAdditionalUrlParam

From Joomla! Documentation

Description

Method to get an additional URL parameter to be added to all pagination class generated links if it exists.



Syntax

getAdditionalUrlParam($key)
Parameter Name Default Value Description
$key $key The name of the URL parameter for which to get the value.

Returns

mixed The value if it exists or null if it does not.

Defined in

libraries/joomla/html/pagination.php

Importing

jimport( 'joomla.html.pagination' );

Source Body

public function getAdditionalUrlParam($key)
{
        $result = isset($this->_additionalUrlParams[$key]) ? $this->_additionalUrlParams[$key] : null;

        return $result;
}



Examples

Code Examples