blob: 0e30ab1e1d402ba7c69ef7a5219f2193210fc4bc (
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
26
27
28
|
<?php
namespace MediaWiki\Hook;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "MaintenanceUpdateAddParams" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface MaintenanceUpdateAddParamsHook {
/**
* Use this hook to add params to the update.php maintenance script.
*
* @since 1.35
*
* @param array &$params Array to populate with the params to be added. Array elements are keyed by
* the param name. Each param is an associative array that must include the following keys:
* - `desc`: The description of the param to show on --help
* - `require`: Is the param required? Defaults to false if not set.
* - `withArg`: Is an argument required with this option? Defaults to false if not set.
* - `shortName`: Character to use as short name, or false if none. Defaults to false if not set.
* - `multiOccurrence`: Can this option be passed multiple times? Defaults to false if not set.
* @return bool|void True or no return value to continue or false to abort
*/
public function onMaintenanceUpdateAddParams( &$params );
}
|
