JPagination/getAdditionalUrlParam: Difference between revisions
From Joomla! Documentation
m clean up |
m preparing for archive only |
||
| Line 4: | Line 4: | ||
===Syntax=== | ===Syntax=== | ||
| Line 39: | Line 39: | ||
===Examples=== | ===Examples=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=getAdditionalUrlParam | category=getAdditionalUrlParam | ||
category=JPagination | category=JPagination | ||
namespace=CodeExample | |||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
Latest revision as of 01:56, 25 March 2017
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