Manual:Hooks/PingLimiter

From MediaWiki.org
Jump to navigation Jump to search
PingLimiter
Available from version 1.9.0
Allows extensions to override the results of User::pingLimiter()
Define function:
public static function onPingLimiter( &$user, $action, &$result ) { ... }
Attach hook:

In extension.json:

{
	"Hooks": {
		"PingLimiter": "MyExtensionHooks::onPingLimiter"
	}
}

For MediaWiki ≤1.25:

$wgHooks['PingLimiter'][] = 'MyExtensionHooks::onPingLimiter';
Called from:File(s): User.php

For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:PingLimiter extensions.

Details[edit]

  • &$user : User performing the action
  • $action : Action being performed
  • &$result : Whether or not the action should be prevented. Change $result and return false to give a definitive answer, otherwise the built-in rate limiting checks are used, if enabled.