File: MessageCache__getHook.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 (26 lines) | stat: -rw-r--r-- 843 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
<?php

namespace MediaWiki\Cache\Hook;

// phpcs:disable Squiz.Classes.ValidClassName.NotCamelCaps
/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "MessageCache::get" to register handlers implementing this interface.
 *
 * @deprecated since 1.41 Use MessageCacheFetchOverrides instead
 * @ingroup Hooks
 */
interface MessageCache__getHook {
	/**
	 * This hook is called when fetching a message. Use this hook to override the key
	 * for customisations. Given and returned message key must be formatted with:
	 * 1) the first letter in lower case according to the content language
	 * 2) spaces replaced with underscores
	 *
	 * @since 1.35
	 *
	 * @param string &$key Message key
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onMessageCache__get( &$key );
}