Extension:CentralNotice/Hooks/CentralNoticeCampaignChange
Appearance
CentralNoticeCampaignChange | |
---|---|
Available from version ??? (Gerrit change 493459) |
|
Define function: | public static function onCentralNoticeCampaignChange( string $action, string $time, string $campaignName, User $user, array $settingsBeforeChanges, array $settingsAfterChanges, ?string $summary ) { ... }
|
Attach hook: | $wgHooks['CentralNoticeCampaignChange'][] = 'MyExtensionHooks::onCentralNoticeCampaignChange';
|
Called from: | File(s): CentralNotice / includes/Campaign.php Function(s): processAfterCampaignChange |
For more information about attaching hooks, see Manual:Hooks .
For examples of other extensions using this hook, see Category:CentralNoticeCampaignChange extensions.
This hook cannot be aborted.
Parameters
[edit]$action
: Astring
, which represents an action related to a campaign. This can be either'created'
,'modified'
, or'removed'
$time
: Astring
representing a database timestamp as returned byIDatabase::timestamp()
$campaignName
: Astring
representing the name of the campaign$user
: An instance ofUser
, representing the user causing the change to the campaign$settingsBeforeChanges
: Anarray
representing the campaign settings before changes, as returned byCampaign::processSettingsForHook
(a private static method)$settingsAfterChanges
: Anarray
representing the campaign settings after changes, as returned byCampaign::processSettingsForHook
(a private static method)$summary
: Represents astring
if a user gave a change summary, ornull
if the user did not.