Extension:UrlGetParameters

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
Crystal Clear action run.svg
UrlGetParameters
Release status: stable
Implementation Parser function
Description Provides a parser function {{#urlget:...}} which allows access to the URL parameters in your page.
Author(s) S.O.E. Ansems
Latest version 1.5.0 (2018-01-06)
MediaWiki 1.23+
Database changes No
License GNU General Public License 2.0 or later
Download
Hooks used
ParserFirstCallInit
Translate the UrlGetParameters extension if it is available at translatewiki.net
Check usage and version matrix.
Vagrant role urlgetparameters

The UrlGetParameters extension enables you to use and/or display the "GET" parameters of the URL, i.e. the query string, on the wiki page.

Download[edit]

The extension can be retrieved directly from Git [?]:

  • Browse code
  • Some extensions have tags for stable releases.
  • Each branch is associated with a past MediaWiki release. There is also a "master" branch containing the latest alpha version (might require an alpha version of MediaWiki).

Extract the snapshot and place it in the extensions/UrlGetParameters/ directory of your MediaWiki installation.

If you are familiar with git and have shell access to your server, you can also obtain the extension as follows:

cd extensions/
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/UrlGetParameters.git

Installation[edit]

  • Download and place the file(s) in a directory called UrlGetParameters in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    require_once "$IP/extensions/UrlGetParameters/UrlGetParameters.php";
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Usage[edit]

Note Note: Caching for the page you use this extension on should be disabled.

To display the value of a URL get parameter in your page, you might do this:

{{#urlget:parameter-name}}

Where parameter-name is the name of the parameter whose value you want. If the parameter is not found, the extension will result in nothing. Alternatively, you can also specify a default value as follows:

{{#urlget:parameter-name|default-value}}

When the parameter parameter-name is not available, then the value default-value is returned.

If the URL contains parameters of the form "A[B]=C", you can display the value "C" in a similar way, by calling:

{{#urlget:A[B]}}

Authors[edit]

This extension was written by S.O.E. Ansems. Important contributions were made by Ankit Garg and some anonymous editors.