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

22 lines
512 B
PHP

<?php
namespace MediaWiki\Hook;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "GetIP" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface GetIPHook {
/**
* Use this hook to modify the IP of the current user (called only once).
*
* @since 1.35
*
* @param string &$ip IP as determined so far
* @return bool|void True or no return value to continue or false to abort
*/
public function onGetIP( &$ip );
}