MediaWiki\Hook\MaintenanceUpdateAddParamsHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onMaintenanceUpdateAddParams (&$params)
	Use this hook to add params to the update.php maintenance script.

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "MaintenanceUpdateAddParams" to register handlers implementing this interface.

Stability: stable

to implement

Definition at line 12 of file MaintenanceUpdateAddParamsHook.php.

Member Function Documentation

onMaintenanceUpdateAddParams()

MediaWiki\Hook\MaintenanceUpdateAddParamsHook::onMaintenanceUpdateAddParams

(

&

$params

)

Use this hook to add params to the update.php maintenance script.

Since

1.35

Parameters

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.

Returns

bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.

---

The documentation for this interface was generated from the following file:

• includes/Hook/MaintenanceUpdateAddParamsHook.php