5e2d63b205
Were not removed in doc review following creation of hook interfaces. Fix line length where needed Change-Id: I2eafffcf3a1c40d0f5613a893c53e0aa14eed6a2
28 lines
1.1 KiB
PHP
28 lines
1.1 KiB
PHP
<?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 );
|
|
}
|