wiki.techinc.nl/includes/cache/Hook/MessageCache__getHook.php
apaskulin c44488f725 docs: Hook interface doc comment review
Edited doc comments for hook interfaces to improve
consistency and add type hints.

Bug: T246855
Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
2020-04-21 09:10:08 +10:00

23 lines
658 B
PHP

<?php
namespace MediaWiki\Cache\Hook;
// phpcs:disable Squiz.Classes.ValidClassName.NotCamelCaps
/**
* @stable for implementation
* @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 );
}