Manual:Hooks/CanIPUseHTTPS

From Linux Web Expert

CanIPUseHTTPS
<translate> Available from <tvar name=1><translate> version <tvar </tvar></translate>
<translate> Removed in <tvar name=1><translate> version <tvar (Gerrit change 675293)</tvar></translate>
Called when checking if an IP address can use HTTPS
<translate> Define function:</translate>
public static function onCanIPUseHTTPS( $ip, &$canDo ) { ... }
<translate> Attach hook:</translate> <translate> In <tvar name=1>extension.json</tvar>:</translate>
{
	"Hooks": {
		"CanIPUseHTTPS": "MediaWiki\\Extension\\MyExtension\\Hooks::onCanIPUseHTTPS"
	}
}
<translate> Called from:</translate> <translate> File(s):</translate> GlobalFunctions.php
<translate> Interface:</translate> CanIPUseHTTPSHook.php

<translate> For more information about attaching hooks, see <tvar name=1>Manual:Hooks </tvar>.</translate>
<translate> For examples of extensions using this hook, see <tvar name=cat>Category:CanIPUseHTTPS extensions</tvar>.</translate>

Details

  • $ip: The IP address in human-readable form
  • &$canDo: This reference should be set to false if the client may not be able to use HTTPS

See also