includes/specialpage/Hook/RedirectSpecialArticleRedirectParamsHook.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

<?php

namespace MediaWiki\SpecialPage\Hook;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "RedirectSpecialArticleRedirectParams" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface RedirectSpecialArticleRedirectParamsHook {
	/**
	 * Use this hook to alter the set of parameter names such as "oldid" that
	 * are preserved when using redirecting special pages such as Special:MyPage
	 * and Special:MyTalk.
	 *
	 * @since 1.35
	 *
	 * @param string[] &$redirectParams Array of parameters preserved by redirecting special pages
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onRedirectSpecialArticleRedirectParams( &$redirectParams );
}