File: GetBlockErrorMessageKeyHook.php

package info (click to toggle)
mediawiki 1%3A1.43.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 417,464 kB
  • sloc: php: 1,062,949; javascript: 664,290; sql: 9,714; python: 5,458; xml: 3,489; sh: 1,131; makefile: 64
file content (27 lines) | stat: -rw-r--r-- 677 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<?php

namespace MediaWiki\Hook;

use MediaWiki\Block\Block;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "GetBlockErrorMessageKey" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface GetBlockErrorMessageKeyHook {
	/**
	 * This hook is called in BlockErrorFormatter to allow
	 * extensions to override the message that will be displayed
	 * to the user.
	 *
	 * @since 1.40
	 *
	 * @param Block $block
	 * @param string &$key
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onGetBlockErrorMessageKey( Block $block, string &$key );
}