MediaWiki extensions manual

IDProvider Release status: stableCategory:Stable extensions
Implementation	Parser function Category:Parser function extensions
Description	Provides IDs using different ID algorithms
Author(s)	Simon Heimler, Alexander Gesinn
Maintainer(s)	gesinn.it
Latest version	3.0.0 (2024-12-16)
MediaWiki	1.39+Category:Extensions with manual MediaWiki version
Database changes	Yes
Composer	gesinn-it/id-provider Category:Extensions supporting Composer
License	MIT License
Download	GitHub: project page git repository URL [help ] commit history Note: No localisation updates are provided by translatewiki.net . Category:Extensions in GitHub version control
Hooks used ParserFirstCallInit Category:ParserFirstCallInit extensions BeforePageDisplay Category:BeforePageDisplay extensions

The IDProvider extension provides the generation of (unique) IDs through different ID algorithms. They can be accessed through parser functions, API or as a static PHP function.

Installation

• Download, extract and place the file(s) in a directory called IDProvider in your extensions/ folder.
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'IDProvider' );
  

• Run the update script which will automatically create the necessary database tables that this extension needs.
• Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Usage

The ApiSandbox will display and document all available options. All parameters are given as key values and work the same way whether you use the parser function, api or a static php call.

{{{info|page name={{#idprovider-increment:Feature_|padding=5}} }}}

{{#idprovider-increment:}}
{{#idprovider-increment:Issue_}}
{{#idprovider-increment:
  |prefix=Issue_
  |padding=5
  |skipUniqueTest=true
}}

{{#idprovider-random:}}
{{#idprovider-random:uuid}}
{{#idprovider-random:fakeid}}
{{#idprovider-random:
  |type=uuid
  |skipUniqueTest=true
}}

$id = IDProviderFunctions::getIncrement([
	'prefix' => '___TEST___',
	'padding' => 8,
]);

$id = IDProviderFunctions::getRandom([
	'type' => 'fakeid',
	'prefix' => 'PREFIX_',
]);

See also

• Extension:IDGenerator - Provides a parser function for numeric IDs. Alternative to IDProvider that can be installed via Composer.

This extension is included in the following wiki farms/hosts and/or packages: semantic::coreCategory:Extensions included in semantic::core This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm.