MediaWiki master
MediaWiki\Hook\GetIPHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onGetIP (&$ip)
 Use this hook to modify the IP of the current user (called only once).
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 12 of file GetIPHook.php.

Member Function Documentation

◆ onGetIP()

MediaWiki\Hook\GetIPHook::onGetIP ( & $ip)

Use this hook to modify the IP of the current user (called only once).

Since
1.35
Parameters
string&$ipIP as determined so far
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: