MediaWiki  master
MediaWiki\User\Hook\UserRequiresHTTPSHook Interface Reference

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

Inheritance diagram for MediaWiki\User\Hook\UserRequiresHTTPSHook:

Public Member Functions

 onUserRequiresHTTPS ( $user, &$https)
 This hook is called to determine whether a user needs to be switched to HTTPS. More...
 

Detailed Description

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

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

Deprecated:
since 1.35

Definition at line 14 of file UserRequiresHTTPSHook.php.

Member Function Documentation

◆ onUserRequiresHTTPS()

MediaWiki\User\Hook\UserRequiresHTTPSHook::onUserRequiresHTTPS (   $user,
$https 
)

This hook is called to determine whether a user needs to be switched to HTTPS.

Deprecated since 1.35 as part of a drive towards deprecation of mixed-protocol wikis.

Since
1.35
Parameters
User$userUser in question.
bool&$httpsBoolean whether $user should be switched to HTTPS.
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.


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