MediaWiki\Hook\IsTrustedProxyHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onIsTrustedProxy ( $ip, &$result)
	Use this hook to override the result of ProxyLookup::isTrustedProxy().

Detailed Description

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

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

Stability: stable

to implement

Definition at line 12 of file IsTrustedProxyHook.php.

Member Function Documentation

onIsTrustedProxy()

MediaWiki\Hook\IsTrustedProxyHook::onIsTrustedProxy	(		$ip,
		&	$result )

Use this hook to override the result of ProxyLookup::isTrustedProxy().

Since

1.35

Parameters

string	$ip	IP being checked
bool	&$result	Change this value to override the result of ProxyLookup::isTrustedProxy()

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:

• includes/Hook/IsTrustedProxyHook.php