Manual:$wgSessionProviders
From Linux Web Expert
<translate> Authentication</translate>: $wgSessionProviders | |
---|---|
Session provider configuration. |
|
<translate> Introduced in version:</translate> | 1.27.0 (Gerrit change 243223; git #a73c5b73) |
<translate> Removed in version:</translate> | <translate> still in use</translate> |
<translate> Allowed values:</translate> | (array of ObjectFactory specifications) |
<translate> Default value:</translate> | see below |
<translate> Other settings:</translate> <translate> Alphabetical</translate> | <translate> By function</translate> |
Details
Specifies what providers to use for SessionManager .
By default, CookieSessionProvider
(for normal cookie-based authentication) and BotPasswordSessionProvider
(for bot passwords) are included.
Order and array keys are not relevant. By convention, the array key is the classname of the provider.
Default values
<td class="mw-version-versionbox" title="<translate nowrap> The latest stable version is <tvar name=1>1.41</tvar></translate>"><translate> ≥</translate> 1.40
<translate> MediaWiki version:</translate> |
$wgSessionProviders = [
\MediaWiki\Session\CookieSessionProvider::class => [
'class' => \MediaWiki\Session\CookieSessionProvider::class,
'args' => [ [
'priority' => 30,
] ],
],
\MediaWiki\Session\BotPasswordSessionProvider::class => [
'class' => \MediaWiki\Session\BotPasswordSessionProvider::class,
'args' => [ [
'priority' => 75,
] ],
'services' => [
'GrantsInfo'
],
],
];
1.39
<translate> MediaWiki version:</translate> |
$wgSessionProviders = [
\MediaWiki\Session\CookieSessionProvider::class => [
'class' => \MediaWiki\Session\CookieSessionProvider::class,
'args' => [ [
'priority' => 30,
'callUserSetCookiesHook' => true,
] ],
],
\MediaWiki\Session\BotPasswordSessionProvider::class => [
'class' => \MediaWiki\Session\BotPasswordSessionProvider::class,
'args' => [ [
'priority' => 75,
] ],
'services' => [
'GrantsInfo'
],
],
];
1.27 – 1.38
<translate> MediaWiki versions:</translate> |
$wgSessionProviders = [
MediaWiki\Session\CookieSessionProvider::class => [
'class' => MediaWiki\Session\CookieSessionProvider::class,
'args' => [ [
'priority' => 30,
'callUserSetCookiesHook' => true,
] ],
],
MediaWiki\Session\BotPasswordSessionProvider::class => [
'class' => MediaWiki\Session\BotPasswordSessionProvider::class,
'args' => [ [
'priority' => 75,
] ],
],
];
Example
$wgSessionProviders[MyCustomSessionProvider::class] = [
'class' => MyCustomSessionProvider::class,
'args' => [ 'arg1', 'arg2' ],
];
or, if the extension uses extension registration (preferable):
{
//...
"SessionProviders": {
"MyCustomSessionProvider": {
"class": "MyCustomSessionProvider",
"args": [ "arg1", "arg2" ]
},
//...
}
This will create a session provider object with new MyCustomSessionProvider( 'arg1', 'arg2' )
, and register it as one of the session providers.
See ObjectFactory for details of the object construction syntax.