includes/ResourceLoader/Hook/ResourceLoaderJqueryMsgModuleMagicWordsHook.php


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
28
29
30

<?php

namespace MediaWiki\ResourceLoader\Hook;

use MediaWiki\ResourceLoader\Context;

/**
 * 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 Context.
	 *
	 * This hook is called from ResourceLoaderJqueryMsgModule.
	 *
	 * @since 1.35
	 * @param Context $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(
		Context $context,
		array &$magicWords
	): void;
}