wiki.techinc.nl/includes/user/Hook/UserRequiresHTTPSHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

28 lines
750 B
PHP

<?php
namespace MediaWiki\User\Hook;
use User;
/**
* 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
* @ingroup Hooks
*/
interface UserRequiresHTTPSHook {
/**
* 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
*
* @param User $user User in question.
* @param bool &$https Boolean whether $user should be switched to HTTPS.
* @return bool|void True or no return value to continue or false to abort
*/
public function onUserRequiresHTTPS( $user, &$https );
}