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

26 lines
777 B
PHP

<?php
namespace MediaWiki\Hook;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "CanIPUseHTTPS" to register handlers implementing this interface.
*
* @deprecated since 1.35
* @ingroup Hooks
*/
interface CanIPUseHTTPSHook {
/**
* Use this hook to determine whether the client at a given source IP is likely
* to be able to access the wiki via HTTPS.
*
* @deprecated since 1.35 This feature will be removed. All clients should use HTTPS.
*
* @since 1.35
*
* @param string $ip IP address in human-readable form
* @param bool &$canDo Set to false if the client may not be able to use HTTPS
* @return bool|void True or no return value to continue or false to abort
*/
public function onCanIPUseHTTPS( $ip, &$canDo );
}