JPagination/getAdditionalUrlParam

The "API16" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description[edit]

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

Syntax[edit]

getAdditionalUrlParam($key)

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

Returns[edit]

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

Defined in[edit]

libraries/joomla/html/pagination.php

Importing[edit]

jimport( 'joomla.html.pagination' );

Source Body[edit]

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

        return $result;
}

Examples[edit]

Code Examples[edit]

API16