Jump to content

Manual:$wgCentralIdLookupProviders

From mediawiki.org
Authentication: $wgCentralIdLookupProviders
Register central ID lookup providers.
Introduced in version:1.27.0 (Gerrit change 254300; git #d032bb52)
Removed in version:Still in use
Allowed values:(array of Provider ID's to ObjectFactory specifications)
Default value:(see below)

Details

[edit]

Used to define what classes implement MediaWiki\User\CentralId\CentralIdLookup for various look up services.

Key is the provider ID, value is a specification for ObjectFactory .

Default values

[edit]
MediaWiki version:
1.42
$wgCentralIdLookupProviders = [
	'local' => [
		'class' => LocalIdLookup::class,
		'services' => [
			'MainConfig',
			'DBLoadBalancerFactory',
			'HideUserUtils',
		]
	],
];
MediaWiki version:
1.41
Gerrit change 925722
$wgCentralIdLookupProviders = [
	'local' => [
		'class' => LocalIdLookup::class,
		'services' => [
			'MainConfig',
			'DBLoadBalancerFactory',
		]
	],
];
MediaWiki versions:
1.37 – 1.40
Gerrit change 700991
$wgCentralIdLookupProviders = [
	'local' => [
		'class' => LocalIdLookup::class,
		'services' => [
			'MainConfig',
			'DBLoadBalancer',
		]
	],
];
MediaWiki versions:
1.31 – 1.36
$wgCentralIdLookupProviders = [
	'local' => [ 'class' => LocalIdLookup::class ],
];
MediaWiki versions:
1.27 – 1.30
$wgCentralIdLookupProviders = [
	'local' => [ 'class' => 'LocalIdLookup' ],
];

Example

[edit]
$wgCentralIdLookupProviders['mycustom'] = [
    'class' => 'MyCustomCentralIdLookup',
    'args' => [ 'arg1', 'arg2' ],
];

or, if the extension uses extension registration (preferable):

{
    //...
    "CentralIdLookupProviders": {
        "mycustom": {
            "class": "MyCustomCentralIdLookup",
            "args": [ "arg1", "arg2" ]
    },
    //...
}

This will create an object with new MyCustomCentralIdLookup( 'arg1', 'arg2' ), and register it as a central ID lookup service.

See also

[edit]