Manual:Hooks/UserRequiresHTTPS

Category:MediaWiki hooks#UserRequiresHTTPS Category:Hooks added in MediaWiki 1.22.0#UserRequiresHTTPS Category:MediaWiki deprecated or obsolete features#UserRequiresHTTPS Category:Hooks removed in MediaWiki 1.37.0#UserRequiresHTTPS Category:Hooks deprecated in MediaWiki 1.35.0#UserRequiresHTTPS
UserRequiresHTTPS
Available from version 1.22.0 (Gerrit change 80030)
Removed in version 1.37.0 (Gerrit change 675293)Category:Removed hooks#UserRequiresHTTPS
Allows extensions to override whether users need to be redirected to HTTPS
Define function:
public static function onUserRequiresHTTPS( $user, &$https ) { ... }
Attach hook: In extension.json:
{
	"Hooks": {
		"UserRequiresHTTPS": "MediaWiki\\Extension\\MyExtension\\Hooks::onUserRequiresHTTPS"
	}
}
Called from: File(s): user/User.phpCategory:MediaWiki hooks included in User.php#UserRequiresHTTPS
Interface: UserRequiresHTTPSHook.php

For more information about attaching hooks, see Manual:Hooks .
For examples of extensions using this hook, see Category:UserRequiresHTTPS extensions.

Details

Allows extensions to override whether users need to be redirected to HTTPS, which is normally decided based on the prefershttps user preference. The value of that preference is passed in as the $https parameter for the hook to manipulate.

See also

Category:Hooks added in MediaWiki 1.22.0 Category:Hooks deprecated in MediaWiki 1.35.0 Category:Hooks removed in MediaWiki 1.37.0 Category:MediaWiki deprecated or obsolete features Category:MediaWiki hooks Category:MediaWiki hooks included in User.php Category:Removed hooks