Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3namespace MediaWiki\Extension\GlobalBlocking\Hook;
4
5/**
6 * This is a hook handler interface, see docs/Hooks.md in core.
7 * Use the hook name "GlobalBlockingBlockedIpXffMsg" to register handlers implementing this interface.
8 *
9 * @ingroup Hooks
10 * @deprecated Since 1.42 - Override the message key globalblocking-ipblocked-xff on the wiki or using the
11 *   MessageCacheFetchOverrides hook.
12 */
13interface GlobalBlockingBlockedIpXffMsgHook {
14
15    /**
16     * Allow extensions to customise the message shown when a user is globally IP rangeblocked, and the block is using
17     * the user's X-Forwarded-For header.
18     *
19     * @param string &$errorMsg Translation key of the message shown to the user.
20     *
21     * @return bool|void True or no return value to continue or false to abort running remaining hook handlers.
22     * @deprecated Since 1.42 - Override the message key globalblocking-ipblocked-xff on the wiki or using the
23     *    MessageCacheFetchOverrides hook.
24     */
25    public function onGlobalBlockingBlockedIpXffMsg( string &$errorMsg );
26
27}