aboutsummaryrefslogtreecommitdiffstats
path: root/includes/Hook/IsTrustedProxyHook.php
blob: 790c608e43c02064435251af3a56027668be7d9f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<?php

namespace MediaWiki\Hook;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "IsTrustedProxy" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface IsTrustedProxyHook {
	/**
	 * Use this hook to override the result of ProxyLookup::isTrustedProxy().
	 *
	 * @since 1.35
	 *
	 * @param string $ip IP being checked
	 * @param bool &$result Change this value to override the result of ProxyLookup::isTrustedProxy()
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onIsTrustedProxy( $ip, &$result );
}