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

30 lines
952 B
PHP

<?php
namespace MediaWiki\ResourceLoader\Hook;
use ResourceLoaderContext;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "ResourceLoaderJqueryMsgModuleMagicWords" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup ResourceLoaderHooks
*/
interface ResourceLoaderJqueryMsgModuleMagicWordsHook {
/**
* Add magic words to the `mediawiki.jqueryMsg` module. The values should be a string,
* and they may only vary by what's in the ResourceLoaderContext.
*
* This hook is called from ResourceLoaderJqueryMsgModule.
*
* @since 1.35
* @param ResourceLoaderContext $context
* @param string[] &$magicWords Associative array mapping all-caps magic word to a string value
* @return void This hook must not abort, it must return no value
*/
public function onResourceLoaderJqueryMsgModuleMagicWords(
ResourceLoaderContext $context,
array &$magicWords
) : void;
}