wiki.techinc.nl/includes/cache/Hook/MessageCache__getHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

26 lines
802 B
PHP

<?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.
*
* @stable to implement
* @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 );
}