MediaWiki master
Public Member Functions | List of all members
MediaWiki\Auth\Hook\AuthManagerFilterProvidersHook Interface Reference
Hooks

This is a hook handler interface, see docs/Hooks.md. More...

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onAuthManagerFilterProviders (array &$providers)
 Filter the list of authentication available providers.
 

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "AuthManagerFilterProviders" to register handlers implementing this interface.

Stability: stable
to implement

Definition at line 14 of file AuthManagerFilterProvidersHook.php.

Member Function Documentation

◆ onAuthManagerFilterProviders()

MediaWiki\Auth\Hook\AuthManagerFilterProvidersHook::onAuthManagerFilterProviders ( array & $providers)

Filter the list of authentication available providers.

Providers removed from the list will be disabled for the current request, and any authentication process started from the current request.

Hook handlers don't have to always return the same result for the given configuration (can depend on the request, e.g. feature flags) but they do have to be consistent within an authentication process that spans multiple requests.

Since
1.43
Parameters
bool[][]&$providersAn array with three sub-arrays: 'preauth', 'primaryauth', 'secondaryauth'. Each field in the subarrays is a map of <provider key> => true. (The provider key is the same array key that's used in $wgAuthManagerAutoConfig or $wgAuthManagerConfig). Unsetting a field or setting its value to falsy disables the corresponding provider. @phpcs:ignore Generic.Files.LineLength.TooLong
Returns
void This hook must not abort, it must return no value
See also
https://www.mediawiki.org/wiki/Manual:Hooks/AuthManagerFilterProviders
MainConfigSchema::AuthManagerAutoConfig

Implemented in MediaWiki\HookContainer\HookRunner.

The documentation for this interface was generated from the following file: