aboutsummaryrefslogtreecommitdiffstats
path: root/includes/Hook/GetDoubleUnderscoreIDsHook.php
blob: 00ad3e61168fceac9f1e18768c7582de9c52bf8e (plain) (blame)
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
<?php

namespace MediaWiki\Hook;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "GetDoubleUnderscoreIDs" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface GetDoubleUnderscoreIDsHook {
	/**
	 * Use this hook to modify the list of behavior switches (double
	 * underscore variables in wikitext).  Behavior switches are localized
	 * with the magic word system, and this hook is called by
	 * MagicWordFactory.
	 *
	 * @since 1.35
	 *
	 * @param string[] &$doubleUnderscoreIDs Array of magic word identifiers
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onGetDoubleUnderscoreIDs( &$doubleUnderscoreIDs );
}