3 This document describes how event hooks work in MediaWiki; how to add hooks for
4 an event; and how to run hooks for an event.
9 Something that happens with the wiki. For example: a user logs in. A wiki
10 page is saved. A wiki page is deleted. Often there are two events
11 associated with a single action: one before the code is run to make the
12 event happen, and one after. Each event has a name, preferably in
13 CamelCase. For example, 'UserLogin', 'ArticleSave', 'ArticleSaveComplete',
17 A clump of code and data that should be run when an event happens. This can
18 be either a function and a chunk of data, or an object and a method.
21 The function part of a hook.
25 Hooks allow us to decouple optionally-run code from code that is run for
26 everyone. It allows MediaWiki hackers, third-party developers and local
27 administrators to define code that will be run at certain points in the mainline
28 code, and to modify the data run by that mainline code. Hooks can keep mainline
29 code simple, and make it easier to write extensions. Hooks are a principled
30 alternative to local patches.
32 Consider, for example, two options in MediaWiki. One reverses the order of a
33 title before displaying the article; the other converts the title to all
34 uppercase letters. Currently, in MediaWiki code, we would handle this as follows
35 (note: not real code, here):
37 function showAnArticle($article) {
38 global $wgReverseTitle, $wgCapitalizeTitle;
40 if ($wgReverseTitle) {
41 wfReverseTitle($article);
44 if ($wgCapitalizeTitle) {
45 wfCapitalizeTitle($article);
48 # code to actually show the article goes here
51 An extension writer, or a local admin, will often add custom code to the
52 function -- with or without a global variable. For example, someone wanting
53 email notification when an article is shown may add:
55 function showAnArticle($article) {
56 global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
58 if ($wgReverseTitle) {
59 wfReverseTitle($article);
62 if ($wgCapitalizeTitle) {
63 wfCapitalizeTitle($article);
66 # code to actually show the article goes here
68 if ($wgNotifyArticle) {
69 wfNotifyArticleShow($article));
73 Using a hook-running strategy, we can avoid having all this option-specific
74 stuff in our mainline code. Using hooks, the function becomes:
76 function showAnArticle($article) {
78 if (wfRunHooks('ArticleShow', array(&$article))) {
80 # code to actually show the article goes here
82 wfRunHooks('ArticleShowComplete', array(&$article));
86 We've cleaned up the code here by removing clumps of weird, infrequently used
87 code and moving them off somewhere else. It's much easier for someone working
88 with this code to see what's _really_ going on, and make changes or fix bugs.
90 In addition, we can take all the code that deals with the little-used
91 title-reversing options (say) and put it in one place. Instead of having little
92 title-reversing if-blocks spread all over the codebase in showAnArticle,
93 deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
96 function reverseArticleTitle($article) {
100 function reverseForExport($article) {
104 The setup function for the extension just has to add its hook functions to the
107 setupTitleReversingExtension() {
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
115 Having all this code related to the title-reversion option in one place means
116 that it's easier to read and understand; you don't have to do a grep-find to see
117 where the $wgReverseTitle variable is used, say.
119 If the code is well enough isolated, it can even be excluded when not used --
120 making for some slight savings in memory and load-up performance at runtime.
121 Admins who want to have all the reversed titles can add:
123 require_once('extensions/ReverseTitle.php');
125 ...to their LocalSettings.php file; those of us who don't want or need it can
128 The extensions don't even have to be shipped with MediaWiki; they could be
129 provided by a third-party developer or written by the admin him/herself.
133 A hook is a chunk of code run at some particular event. It consists of:
135 * a function with some optional accompanying data, or
136 * an object with a method and some optional accompanying data.
138 Hooks are registered by adding them to the global $wgHooks array for a given
139 event. All the following are valid ways to define hooks:
141 $wgHooks['EventName'][] = 'someFunction'; # function, no data
142 $wgHooks['EventName'][] = array('someFunction', $someData);
143 $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
145 $wgHooks['EventName'][] = $object; # object only
146 $wgHooks['EventName'][] = array($object, 'someMethod');
147 $wgHooks['EventName'][] = array($object, 'someMethod', $someData);
148 $wgHooks['EventName'][] = array($object); # weird but OK
150 When an event occurs, the function (or object method) will be called with the
151 optional data provided as well as event-specific parameters. The above examples
152 would result in the following code being executed when 'EventName' happened:
155 someFunction($param1, $param2)
157 someFunction($someData, $param1, $param2)
160 $object->onEventName($param1, $param2)
162 $object->someMethod($param1, $param2)
163 # object with method and data
164 $object->someMethod($someData, $param1, $param2)
166 Note that when an object is the hook, and there's no specified method, the
167 default method called is 'onEventName'. For different events this would be
168 different: 'onArticleSave', 'onUserLogin', etc.
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
173 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
174 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
179 Hooks can return three possible values:
181 * true: the hook has operated successfully
182 * "some string": an error occurred; processing should stop and the error
183 should be shown to the user
184 * false: the hook has successfully done the work necessary and the calling
187 The last result would be for cases where the hook function replaces the main
188 functionality. For example, if you wanted to authenticate users to a custom
189 system (LDAP, another PHP program, whatever), you could do:
191 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
193 function ldapLogin($username, $password) {
198 Returning false makes less sense for events where the action is complete, and
199 will normally be ignored.
201 Note that none of the examples made use of create_function() as a way to
202 attach a function to a hook. This is known to cause problems (notably with
203 Special:Version), and should be avoided when at all possible.
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
214 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
215 # protect the article
216 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
221 wfRunHooks() returns true if the calling function should continue processing
222 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
223 error occurred, or one of the hooks handled the action already). Checking the
224 return value matters more for "before" hooks than for "complete" hooks.
226 Note that hook parameters are passed in an array; this is a necessary
227 inconvenience to make it possible to pass reference values (that can be changed)
228 into the hook code. Also note that earlier versions of wfRunHooks took a
229 variable number of arguments; the array() calling protocol came about after
232 ==Events and parameters==
234 This is a list of known events and parameters; please add to it if you're going
235 to add events to the MediaWiki code.
237 'AbortAutoblock': Return false to cancel an autoblock.
238 $autoblockip: The IP going to be autoblocked.
239 $block: The block from which the autoblock is coming.
241 'AbortDiffCache': Can be used to cancel the caching of a diff
242 &$diffEngine: DifferenceEngine object
244 'AbortLogin': Return false to cancel account login.
245 $user: the User object being authenticated against
246 $password: the password being submitted, not yet checked for validity
247 &$retval: a LoginForm class constant to return from authenticateUserData();
248 default is LoginForm::ABORTED. Note that the client may be using
249 a machine API rather than the HTML user interface.
251 'AbortMove': allows to abort moving an article (title)
254 $user: user who is doing the move
256 $reason: the reason for the move (added in 1.13)
258 'AbortNewAccount': Return false to cancel account creation.
259 $user: the User object about to be created (read-only, incomplete)
260 $message: out parameter: error message to display on abort
262 'AddNewAccount': after a user account is created
263 $user: the User object that was created. (Parameter added in 1.7)
264 $byEmail: true when account was created "by email" (added in 1.12)
266 'AjaxAddScript': Called in output page just before the initialisation
267 of the javascript ajax engine. The hook is only called when ajax
268 is enabled ( $wgUseAjax = true; ).
270 'AlternateEdit': before checking if an user can edit a page and
271 before showing the edit form ( EditPage::edit() ). This is triggered
273 $EditPage: the EditPage object
275 'APIAfterExecute': after calling the execute() method of an API module.
276 Use this to extend core API modules.
277 &$module: Module object
279 'APIEditBeforeSave': before saving a page with api.php?action=edit,
280 after processing request parameters. Return false to let the request
281 fail, returning an error message or an <edit result="Failure"> tag
282 if $resultArr was filled.
283 $EditPage : the EditPage object
284 $text : the new text of the article (has yet to be saved)
285 $resultArr : data in this array will be added to the API result
287 'APIGetAllowedParams': use this hook to modify a module's parameters.
288 &$module: Module object
289 &$params: Array of parameters
291 'APIGetParamDescription': use this hook to modify a module's parameter
293 &$module: Module object
294 &$desc: Array of parameter descriptions
296 'APIQueryAfterExecute': after calling the execute() method of an
297 action=query submodule. Use this to extend core API modules.
298 &$module: Module object
300 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
301 method of an action=query submodule. Use this to extend core API modules.
302 &$module: Module object
303 &$resultPageSet: ApiPageSet object
305 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
306 Every token has an action, which will be used in the intoken parameter
307 and in the output (actiontoken="..."), and a callback function which
308 should return the token, or false if the user isn't allowed to obtain
309 it. The prototype of the callback function is func($pageid, $title)
310 where $pageid is the page ID of the page the token is requested for
311 and $title is the associated Title object. In the hook, just add
312 your callback to the $tokenFunctions array and return true (returning
313 false makes no sense)
314 $tokenFunctions: array(action => callback)
316 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
317 Every token has an action, which will be used in the rvtoken parameter
318 and in the output (actiontoken="..."), and a callback function which
319 should return the token, or false if the user isn't allowed to obtain
320 it. The prototype of the callback function is func($pageid, $title, $rev)
321 where $pageid is the page ID of the page associated to the revision the
322 token is requested for, $title the associated Title object and $rev the
323 associated Revision object. In the hook, just add your callback to the
324 $tokenFunctions array and return true (returning false makes no sense)
325 $tokenFunctions: array(action => callback)
327 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
329 Every token has an action, which will be used in the rctoken parameter
330 and in the output (actiontoken="..."), and a callback function which
331 should return the token, or false if the user isn't allowed to obtain
332 it. The prototype of the callback function is func($pageid, $title, $rc)
333 where $pageid is the page ID of the page associated to the revision the
334 token is requested for, $title the associated Title object and $rc the
335 associated RecentChange object. In the hook, just add your callback to the
336 $tokenFunctions array and return true (returning false makes no sense)
337 $tokenFunctions: array(action => callback)
339 'APIQueryUsersTokens': use this hook to add custom token to list=users.
340 Every token has an action, which will be used in the ustoken parameter
341 and in the output (actiontoken="..."), and a callback function which
342 should return the token, or false if the user isn't allowed to obtain
343 it. The prototype of the callback function is func($user) where $user
344 is the User object. In the hook, just add your callback to the
345 $tokenFunctions array and return true (returning false makes no sense)
346 $tokenFunctions: array(action => callback)
348 'ArticleAfterFetchContent': after fetching content of an article from
350 $article: the article (object) being loaded from the database
351 $content: the content (string) of the article
353 'ArticleDelete': before an article is deleted
354 $article: the article (object) being deleted
355 $user: the user (object) deleting the article
356 $reason: the reason (string) the article is being deleted
357 $error: if the deletion was prohibited, the (raw HTML) error message to display
360 'ArticleDeleteComplete': after an article is deleted
361 $article: the article that was deleted
362 $user: the user that deleted the article
363 $reason: the reason the article was deleted
364 $id: id of the article that was deleted
366 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
368 $article: article (object) of the user talk page
370 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
371 article has been changed
372 $article: the article (object)
373 $editInfo: data holder that includes the parser output ($editInfo->output) for
374 that page after the change
375 $changed: bool for if the page was changed
377 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
378 recentchanges table, return false to not delete old entries
379 $article: article (object) being modified
381 'ArticleFromTitle': when creating an article object from a title object using
382 Wiki::articleFromTitle()
383 $title: title (object) used to create the article object
384 $article: article (object) that will be returned
386 'ArticleInsertComplete': After a new article is created
387 $article: Article created
388 $user: User creating the article
390 $summary: Edit summary/comment
391 $isMinor: Whether or not the edit was marked as minor
392 $isWatch: (No longer used)
393 $section: (No longer used)
394 $flags: Flags passed to Article::doEdit()
395 $revision: New Revision of the article
397 'ArticleMergeComplete': after merging to article using Special:Mergehistory
398 $targetTitle: target title (object)
399 $destTitle: destination title (object)
401 'ArticlePageDataAfter': after loading data of an article from the database
402 $article: article (object) whose data were loaded
403 $row: row (object) returned from the database server
405 'ArticlePageDataBefore': before loading data of an article from the database
406 $article: article (object) that data will be loaded
407 $fields: fileds (array) to load from the database
409 'ArticleProtect': before an article is protected
410 $article: the article being protected
411 $user: the user doing the protection
412 $protect: boolean whether this is a protect or an unprotect
413 $reason: Reason for protect
414 $moveonly: boolean whether this is for move only or not
416 'ArticleProtectComplete': after an article is protected
417 $article: the article that was protected
418 $user: the user who did the protection
419 $protect: boolean whether it was a protect or an unprotect
420 $reason: Reason for protect
421 $moveonly: boolean whether it was for move only or not
423 'ArticlePurge': before executing "&action=purge"
424 $article: article (object) to purge
426 'ArticleRevisionVisiblitySet': called when changing visibility of one or more
427 revision of an article
428 &$title: title object of the article
430 'ArticleRevisionUndeleted': after an article revision is restored
431 $title: the article title
432 $revision: the revision
433 $oldPageID: the page ID of the revision when archived (may be null)
435 'ArticleRollbackComplete': after an article rollback is completed
436 $article: the article that was edited
437 $user: the user who did the rollback
438 $revision: the revision the page was reverted back to
439 $current: the reverted revision
441 'ArticleSave': before an article is saved
442 $article: the article (object) being saved
443 $user: the user (object) saving the article
444 $text: the new article text
445 $summary: the article summary (comment)
450 'ArticleSaveComplete': After an article has been updated
451 $article: Article modified
452 $user: User performing the modification
454 $summary: Edit summary/comment
455 $isMinor: Whether or not the edit was marked as minor
456 $isWatch: (No longer used)
457 $section: (No longer used)
458 $flags: Flags passed to Article::doEdit()
459 $revision: New Revision of the article
460 $baseRevId: the rev ID (or false) this edit was based on
462 'ArticleUndelete': When one or more revisions of an article are restored
463 $title: Title corresponding to the article restored
464 $create: Whether or not the restoration caused the page to be created
465 (i.e. it didn't exist before)
466 $comment: The comment associated with the undeletion.
468 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
469 before the user is redirected back to the page
470 &$article: the article
471 &$sectionanchor: The section anchor link (e.g. "#overview" )
472 &$extraq: Extra query parameters which can be added via hooked functions
474 'ArticleViewHeader': Before the parser cache is about to be tried for article
476 &$article: the article
477 &$pcache: whether to try the parser cache or not
478 &$outputDone: whether the output for this page finished or not
480 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
482 $article: target article (object)
484 'AuthPluginAutoCreate': Called when creating a local account for an user logged
485 in from an external authentication method
486 $user: User object created locally
488 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
489 Gives a chance for an extension to set it programattically to a variable class.
490 &$auth: the $wgAuth object, probably a stub
492 'AutopromoteCondition': check autopromote condition for user.
493 $type: condition type
496 $result: result of checking autopromote condition
498 'BadImage': When checking against the bad image list
499 $name: Image name being checked
500 &$bad: Whether or not the image is "bad"
502 Change $bad and return false to override. If an image is "bad", it is not
503 rendered inline in wiki pages or galleries in category pages.
505 'BeforeGalleryFindFile': before an image is fetched for a gallery
506 &$gallery,: the gallery object
507 &$nt: the image title
508 &$time: image timestamp
510 'BeforePageDisplay': Prior to outputting a page
511 &$out: OutputPage object
514 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
515 &$parser: Parser object
516 &$title: title of the template
517 &$skip: skip this template and link it?
518 &$id: the id of the revision being parsed
520 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
521 &$parser: Parser object
522 &$nt: the image title
523 &$skip: skip this image and link it?
524 &$time: the image timestamp
526 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
527 &$parser: Parser object
528 &$ig: ImageGallery object
530 'BlockIp': before an IP address or user is blocked
531 $block: the Block object about to be saved
532 $user: the user _doing_ the block (not the one being blocked)
534 'BlockIpComplete': after an IP address or user is blocked
535 $block: the Block object that was saved
536 $user: the user who did the block (not the one being blocked)
538 'BookInformation': Before information output on Special:Booksources
539 $isbn: ISBN to show information for
540 $output: OutputPage object in use
542 'CategoryPageView': before viewing a categorypage in CategoryPage::view
543 $catpage: CategoryPage instance
545 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
546 &$this: ChangesList instance.
547 &$articlelink: HTML of link to article (already filled-in).
548 &$s: HTML of row that is being constructed.
549 &$rc: RecentChange instance.
550 $unpatrolled: Whether or not we are showing unpatrolled changes.
551 $watched: Whether or not the change is watched by the user.
553 'ContribsPager::getQueryInfo': Before the contributions query is about to run
554 &$pager: Pager object for contributions
555 &queryInfo: The query for the contribs Pager
557 'ContributionsLineEnding': Called before a contributions HTML line is finished
558 $page: SpecialPage object for contributions
560 $row: the DB row for this line
562 'ContributionsToolLinks': Change tool links above Special:Contributions
564 $title: User page title
565 &$tools: Array of tool links
567 'CustomEditor': When invoking the page editor
568 $article: Article being edited
569 $user: User performing the edit
571 Return true to allow the normal editor to be used, or false
572 if implementing a custom editor, e.g. for a special namespace,
575 'DatabaseOraclePostInit': Called after initialising an Oracle database
576 &$db: the DatabaseOracle object
578 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
579 $title: the diff page title (nullable)
580 &$oldId: the actual old Id to use in the diff
581 &$newId: the actual new Id to use in the diff (0 means current)
582 $old: the ?old= param value from the url
583 $new: the ?new= param value from the url
585 'DiffViewHeader': called before diff display
586 $diff: DifferenceEngine object that's calling
587 $oldRev: Revision object of the "old" revision (may be null/invalid)
588 $newRev: Revision object of the "new" revision
590 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
592 $article: article (object) being viewed
593 $oldid: oldid (int) being viewed
595 'DoEditSectionLink': Override the HTML generated for section edit links
596 $skin: Skin object rendering the UI
597 $title: Title object for the title being linked to (may not be the same as
598 $wgTitle, if the section is included from a template)
599 $section: The designation of the section being pointed to, to be included in
600 the link, like "§ion=$section"
601 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
602 By default, this is wrapped in the 'editsectionhint' message.
603 $result: The HTML to return, prefilled with the default plus whatever other
604 changes earlier hooks have made
606 'EditFilter': Perform checks on an edit
607 $editor: Edit form (see includes/EditPage.php)
608 $text: Contents of the edit box
609 $section: Section being edited
610 &$error: Error message to return
611 $summary: Edit summary for page
613 'EditFilterMerged': Post-section-merge edit filter
614 $editor: EditPage instance (object)
615 $text: content of the edit box
616 $error: error message to return
617 $summary: Edit summary for page
619 'EditFormPreloadText': Allows population of the edit form when creating
621 &$text: Text to preload with
622 &$title: Title object representing the page being created
624 'EditPage::attemptSave': called before an article is
625 saved, that is before insertNewArticle() is called
626 &$editpage_Obj: the current EditPage object
628 'EditPage::importFormData': allow extensions to read additional data
630 $editpage: EditPage instance
632 return value is ignored (should always return true)
634 'EditPage::showEditForm:fields': allows injection of form field into edit form
635 &$editor: the EditPage instance for reference
636 &$out: an OutputPage instance to write to
637 return value is ignored (should always return true)
639 'EditPage::showEditForm:initial': before showing the edit form
640 $editor: EditPage instance (object)
642 Return false to halt editing; you'll need to handle error messages, etc.
643 yourself. Alternatively, modifying $error and returning true will cause the
644 contents of $error to be echoed at the top of the edit form as wikitext.
645 Return true without altering $error to allow the edit to proceed.
647 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
648 when there's an edit conflict. Return false to halt normal diff output; in
649 this case you're responsible for computing and outputting the entire "conflict"
650 part, i.e., the "difference between revisions" and "your text" headers and
652 &$editor: EditPage instance
653 &$out: OutputPage instance
655 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
656 textarea in the edit form
657 &$editpage: The current EditPage object
658 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
659 &$tabindex: HTML tabindex of the last edit check/button
661 'EditPageBeforeEditChecks': allows modifying the edit checks below the
662 textarea in the edit form
663 &$editpage: The current EditPage object
664 &$checks: Array of edit checks like "watch this page"/"minor edit"
665 &$tabindex: HTML tabindex of the last edit check/button
667 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
668 textarea in the edit form
669 &$toolbar: The toolbar HTMl
671 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
672 $title: title of page being edited
673 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
675 'EditPageTosSummary': Give a chance for site and per-namespace customizations
676 of terms of service summary link that might exist separately from the copyright
678 $title: title of page being edited
679 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
681 'EditSectionLink': Do not use, use DoEditSectionLink instead.
682 $skin: Skin rendering the UI
683 $title: Title being linked to
684 $section: Section to link to
686 $result: Result (alter this to override the generated links)
688 'EmailConfirmed': When checking that the user's email address is "confirmed"
689 $user: User being checked
690 $confirmed: Whether or not the email address is confirmed
691 This runs before the other checks, such as anonymity and the real check; return
692 true to allow those checks to occur, and false if checking is done.
694 'EmailUser': before sending email from one user to another
695 $to: address of receiving user
696 $from: address of sending user
697 $subject: subject of the mail
698 $text: text of the mail
700 'EmailUserComplete': after sending email from one user to another
701 $to: address of receiving user
702 $from: address of sending user
703 $subject: subject of the mail
704 $text: text of the mail
706 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
707 $user: The user who is trying to email another user.
708 $editToken: The user's edit token.
709 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
711 'FetchChangesList': When fetching the ChangesList derivative for
713 &$user: User the list is being fetched for
714 &$skin: Skin object to be used with the list
715 &$list: List object (defaults to NULL, change it to an object
716 instance and return false override the list derivative used)
718 'FileDeleteComplete': When a file is deleted
719 $file: reference to the deleted file
720 $oldimage: in case of the deletion of an old image, the name of the old file
721 $article: in case all revisions of the file are deleted a reference to the
722 article associated with the file.
723 $user: user who performed the deletion
726 'FileUpload': When a file upload occurs
727 $file : Image object representing the file that was uploaded
729 'FileUndeleteComplete': When a file is undeleted
730 $title: title object to the file
731 $fileVersions: array of undeleted versions. Empty if all versions were restored
732 $user: user who performed the undeletion
735 'GetAutoPromoteGroups': When determining which autopromote groups a user
736 is entitled to be in.
737 &$user: user to promote.
738 &$promote: groups that will be added.
740 'GetBlockedStatus': after loading blocking status of an user from the database
741 $user: user (object) being checked
743 'GetCacheVaryCookies': get cookies that should vary cache options
744 $out: OutputPage object
745 &$cookies: array of cookies name, add a value to it if you want to add a cookie
746 that have to vary cache options
748 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
749 $title: Title object of page
750 $url: string value as output (out parameter, can modify)
751 $query: query options passed to Title::getFullURL()
753 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
754 $title: Title object of page
755 $url: string value as output (out parameter, can modify)
756 $query: query options passed to Title::getInternalURL()
758 'GetLinkColours': modify the CSS class of an array of page links
759 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
761 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
763 'GetLocalURL': modify local URLs as output into page links
764 $title: Title object of page
765 $url: string value as output (out parameter, can modify)
766 $query: query options passed to Title::getLocalURL()
768 'GetPreferences': modify user preferences
769 $user: User whose preferences are being modified.
770 &$preferences: Preferences description array, to be fed to an HTMLForm object
772 'getUserPermissionsErrors': Add a permissions error when permissions errors are
773 checked for. Use instead of userCan for most cases. Return false if the
774 user can't do it, and populate $result with the reason in the form of
775 array( messagename, param1, param2, ... ). For consistency, error messages
776 should be plain text with no special coloring, bolding, etc. to show that
777 they're errors; presenting them properly to the user as errors is done by
779 $title: Title object being checked against
780 $user : Current user object
781 $action: Action being checked
782 $result: User permissions error to add. If none, return true.
784 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
785 if expensive checks are enabled.
787 'HTMLCacheUpdate::doUpdate': After cache invalidation updates are inserted
789 $title: Title object, pages linked to this title are purged.
791 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
792 image insertion. You can skip the default logic entirely by returning
793 false, or just modify a few things using call-by-reference.
795 &$title: Title object of the image
796 &$file: File object, or false if it doesn't exist
797 &$frameParams: Various parameters with special meanings; see documentation in
798 includes/Linker.php for Linker::makeImageLink2
799 &$handlerParams: Various parameters with special meanings; see documentation in
800 includes/Linker.php for Linker::makeImageLink2
801 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
802 &$res: Final HTML output, used if you return false
805 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
806 the image on an image page
807 $imagePage: ImagePage object ($this)
810 'ImagePageFileHistoryLine': called when a file history line is contructed
812 $line: the HTML of the history line
813 $css: the line CSS class
815 'ImagePageFindFile': called when fetching the file associated with an image page
816 $page: ImagePage object
818 &$displayFile: displayed File object
820 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
821 $title: Title object ($wgTitle)
823 $ignoreRedirect: boolean to skip redirect check
824 $target: Title/string of redirect target
825 $article: Article object
827 'InternalParseBeforeLinks': during Parser's internalParse method before links
828 but after noinclude/includeonly/onlyinclude and other processing.
829 &$this: Parser object
830 &$text: string containing partially parsed text
831 &$this->mStripState: Parser's internal StripState object
833 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
834 $article: article (object) being checked
836 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
838 $result: Change this value to override the result of wfIsTrustedProxy()
840 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
841 tance to return false if the domain name doesn't match your organization
842 $addr: The e-mail address entered by the user
843 &$result: Set this and return false to override the internal checks
845 'isValidPassword': Override the result of User::isValidPassword()
846 $password: The password entered by the user
847 &$result: Set this to either true (passes) or the key for a message error
848 $user: User the password is being validated for
850 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
851 $wgExtensionMessagesFiles instead.
852 Use this to define synonyms of magic words depending of the language
853 $magicExtensions: associative array of magic words synonyms
854 $lang: laguage code (string)
856 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
857 listed in $wgExtensionMessagesFiles instead.
858 Use to define aliases of special pages names depending of the language
859 $specialPageAliases: associative array of magic words synonyms
860 $lang: laguage code (string)
862 'LinkBegin': Used when generating internal and interwiki links in
863 Linker::link(), before processing starts. Return false to skip default proces-
864 sing and return $ret. See documentation for Linker::link() for details on the
865 expected meanings of parameters.
866 $skin: the Skin object
867 $target: the Title that the link is pointing to
868 &$text: the contents that the <a> tag should have (raw HTML); null means "de-
870 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
871 tive array form, with keys and values unescaped. Should be merged with de-
872 fault values, with a value of false meaning to suppress the attribute.
873 &$query: the query string to add to the generated URL (the bit after the "?"),
874 in associative array form, with keys and values unescaped.
875 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
876 &$ret: the value to return if your hook returns false.
878 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
879 just before the function returns a value. If you return true, an <a> element
880 with HTML attributes $attribs and contents $text will be returned. If you re-
881 turn false, $ret will be returned.
882 $skin: the Skin object
883 $target: the Title object that the link is pointing to
884 $options: the options. Will always include either 'known' or 'broken', and may
886 &$text: the final (raw HTML) contents of the <a> tag, after processing.
887 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
889 &$ret: the value to return if your hook returns false.
891 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
894 &$alt: the image's alt text
895 &$img: the new image HTML (if returning false)
897 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
900 &$text: the link text
901 &$link: the new link HTML (if returning false)
902 &$attribs: the attributes to be applied.
903 $linkType: The external link type
905 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
907 &$linksUpdate: the LinkUpdate object
909 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
911 &$linksUpdate: the LinkUpdate object
913 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
914 &$linksUpdate: the LinkUpdate object
916 'ListDefinedTags': When trying to find all defined tags.
917 &$tags: The list of tags.
919 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading
922 'LocalFile::getHistory': called before file history query performed
925 $fields: select fields
928 $join_conds: JOIN conditions
930 'LocalisationCacheRecache': Called when loading the localisation data into cache
931 $cache: The LocalisationCache object
933 &$alldata: The localisation data from core and extensions
935 'LoginAuthenticateAudit': a login attempt for a valid user account either
936 succeeded or failed. No return data is accepted; this hook is for auditing only.
937 $user: the User object being authenticated against
938 $password: the password being submitted and found wanting
939 $retval: a LoginForm class constant with authenticateUserData() return
940 value (SUCCESS, WRONG_PASS, etc)
942 'LogLine': Processes a single log entry on Special:Log
943 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
944 logging.log_type database field.
945 $log_action: string for the type of log action (e.g. 'delete', 'block',
946 'create2'). Corresponds to logging.log_action database field.
947 $title: Title object that corresponds to logging.log_namespace and
948 logging.log_title database fields.
949 $paramArray: Array of parameters that corresponds to logging.log_params field.
950 Note that only $paramArray[0] appears to contain anything.
951 &$comment: string that corresponds to logging.log_comment database field, and
952 which is displayed in the UI.
953 &$revert: string that is displayed in the UI, similar to $comment.
954 $time: timestamp of the log entry (added in 1.12)
956 'LogPageValidTypes': action being logged.
957 DEPRECATED: Use $wgLogTypes
958 &$type: array of strings
960 'LogPageLogName': name of the logging page(s).
961 DEPRECATED: Use $wgLogNames
962 &$typeText: array of strings
964 'LogPageLogHeader': strings used by wfMsg as a header.
965 DEPRECATED: Use $wgLogHeaders
966 &$headerText: array of strings
968 'LogPageActionText': strings used by wfMsg as a header.
969 DEPRECATED: Use $wgLogActions
970 &$actionText: array of strings
972 'MagicWordMagicWords': When defining new magic word.
973 DEPRECATED: Use LanguageGetMagic hook instead
974 $magicWords: array of strings
976 'MagicWordwgVariableIDs': When definig new magic words IDs.
977 $variableIDs: array of strings
979 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
981 &$vars: variable (or multiple variables) to be added into the output
982 of Skin::makeVariablesScript
984 'MarkPatrolled': before an edit is marked patrolled
985 $rcid: ID of the revision to be marked patrolled
986 $user: the user (object) marking the revision as patrolled
987 $wcOnlySysopsCanPatrol: config setting indicating whether the user
988 needs to be a sysop in order to mark an edit patrolled
990 'MarkPatrolledComplete': after an edit is marked patrolled
991 $rcid: ID of the revision marked as patrolled
992 $user: user (object) who marked the edit patrolled
993 $wcOnlySysopsCanPatrol: config setting indicating whether the user
994 must be a sysop to patrol the edit
996 'MathAfterTexvc': after texvc is executed when rendering mathematics
997 $mathRenderer: instance of MathRenderer
998 $errmsg: error message, in HTML (string). Nonempty indicates failure
999 of rendering the formula
1001 'MediaWikiPerformAction': Override MediaWiki::performAction().
1002 Use this to do something completely different, after the basic
1003 globals have been set up, but before ordinary actions take place.
1005 $article: $wgArticle
1008 $request: $wgRequest
1009 $this: The $mediawiki object
1011 'MessagesPreLoad': When loading a message from the database
1012 $title: title of the message (string)
1013 $message: value (string), change it to the message you want to define
1015 'MessageCacheReplace': When a message page is changed.
1016 Useful for updating caches.
1017 $title: name of the page changed.
1018 $text: new contents of the page.
1020 'ModifyExportQuery': Modify the query used by the exporter.
1021 $db: The database object to be queried.
1022 &$tables: Tables in the query.
1023 &$conds: Conditions in the query.
1024 &$opts: Options for the query.
1025 &$join_conds: Join conditions for the query.
1027 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1028 been rendered (useful for adding more)
1029 Note: this is only run for the Monobook skin. To add items to the toolbox
1030 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
1032 $tools: array of tools
1034 'NewRevisionFromEditComplete': called when a revision was inserted
1036 $article: the article edited
1037 $rev: the new revision
1038 $baseID: the revision ID this was based off, if any
1039 $user: the editing user
1041 'NormalizeMessageKey': Called before the software gets the text of a message
1042 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1044 &$key: the message being looked up. Change this to something else to change
1045 what message gets displayed (string)
1046 &$useDB: whether or not to look up the message in the database (bool)
1047 &$langCode: the language code to get the message for (string) - or -
1048 whether to use the content language (true) or site language (false) (bool)
1049 &$transform: whether or not to expand variables and templates
1050 in the message (bool)
1052 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1053 &$changeslist: The OldChangesList instance.
1054 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1055 &$rc: The RecentChange object.
1057 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1058 Hooks can alter or append to the array of URLs for search & suggestion formats.
1059 &$urls: array of associative arrays with Url element attributes
1061 'OutputPageBeforeHTML': a page has been processed by the parser and
1062 the resulting HTML is about to be displayed.
1063 $parserOutput: the parserOutput (object) that corresponds to the page
1064 $text: the text that will be displayed, in HTML (string)
1066 'OutputPageCheckLastModified': when checking if the page has been modified
1067 since the last visit
1068 &$modifiedTimes: array of timestamps.
1069 The following keys are set: page, user, epoch
1071 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1072 $out: OutputPage instance (object)
1073 $parserOutput: parserOutput instance being added in $out
1075 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1076 categories. Implementations should return false if they generate the category
1077 links, so the default link generation is skipped.
1078 $out: OutputPage instance (object)
1079 $categories: associative array, keys are category names, values are category
1080 types ("normal" or "hidden")
1081 $links: array, intended to hold the result. Must be an associative array with
1082 category types as keys and arrays of HTML links as values.
1084 'PageHistoryBeforeList': When a history page list is about to be constructed.
1085 $article: the article that the history is loading for
1087 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1088 $row: the revision row for this line
1089 $s: the string representing this parsed line
1091 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1094 $queryInfo: the query parameters
1096 'PageRenderingHash': alter the parser cache option hash key
1097 A parser extension which depends on user options should install
1098 this hook and append its values to the key.
1099 $hash: reference to a hash key string which can be modified
1101 'ParserAfterStrip': Same as ParserBeforeStrip
1103 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1104 $parser: Parser object being used
1105 $text: text that'll be returned
1107 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1108 $parser: Parser object
1109 $text: text to parse
1110 $stripState: StripState instance being used
1112 'ParserBeforeStrip': Called at start of parsing time
1113 (no more strip, deprecated ?)
1114 $parser: parser object
1115 $text: text being parsed
1116 $stripState: stripState used (object)
1118 'ParserBeforeTidy': called before tidy and custom tags replacements
1119 $parser: Parser object being used
1122 'ParserClearState': called at the end of Parser::clearState()
1123 $parser: Parser object being cleared
1125 'ParserFirstCallInit': called when the parser initialises for the first time
1126 &$parser: Parser object being cleared
1128 'ParserGetVariableValueSwitch': called when the parser need the value of a
1130 $parser: Parser object
1131 $varCache: array to store the value in case of multiples calls of the
1133 $index: index (string) of the magic
1134 $ret: value of the magic word (the hook should set it)
1136 'ParserGetVariableValueTs': use this to change the value of the time for the
1137 {{LOCAL...}} magic word
1138 $parser: Parser object
1139 $time: actual time (timestamp)
1141 'ParserGetVariableValueVarCache': use this to change the value of the
1142 variable cache or return false to not use it
1143 $parser: Parser object
1144 $varCache: varaiable cache (array)
1146 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1147 include comments about size of the text parsed
1148 $parser: Parser object
1149 $limitReport: text that will be included (without comment tags)
1151 'ParserMakeImageParams': Called before the parser make an image link, use this
1152 to modify the parameters of the image.
1153 $title: title object representing the file
1154 $file: file object that will be used to create the image
1155 &$params: 2-D array of parameters
1157 'ParserTestParser': called when creating a new instance of Parser in
1158 maintenance/parserTests.inc
1159 $parser: Parser object created
1161 'ParserTestTables': alter the list of tables to duplicate when parser tests
1162 are run. Use when page save hooks require the presence of custom tables
1163 to ensure that tests continue to run properly.
1164 &$tables: array of table names
1166 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1167 my talk page, my contributions" etc).
1169 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1170 &$title: Title object representing the current page
1172 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1173 &$user : User performing the action
1174 $action : Action being performed
1175 &$result : Whether or not the action should be prevented
1176 Change $result and return false to give a definitive answer, otherwise
1177 the built-in rate limiting checks are used, if enabled.
1179 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1180 AJAX search suggestions. Put results into &$results outparam and return false.
1181 $ns : array of int namespace keys to search in
1182 $search : search term (not guaranteed to be conveniently normalized)
1183 $limit : maximum number of results to return
1184 &$results : out param: array of page names (strings)
1186 'PrefsEmailAudit': called when user changes his email address
1187 $user: User (object) changing his email address
1188 $oldaddr: old email address (string)
1189 $newaddr: new email address (string)
1191 'PrefsPasswordAudit': called when user changes his password
1192 $user: User (object) changing his passoword
1193 $newPass: new password
1194 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1196 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1197 &$obj: RawPage object
1198 &$text: The text that's going to be the output
1200 'RecentChange_save': called at the end of RecenChange::save()
1201 $recentChange: RecentChange object
1203 'RevisionInsertComplete': called after a revision is inserted into the DB
1204 &$revision: the Revision
1205 $data: the data stored in old_text. The meaning depends on $flags: if external
1206 is set, it's the URL of the revision text in external storage; otherwise,
1207 it's the revision text itself. In either case, if gzip is set, the revision
1209 $flags: a comma-delimited list of strings representing the options used. May
1210 include: utf8 (this will always be set for new revisions); gzip; external.
1212 'SearchUpdate': Prior to search update completion
1214 $namespace : Page namespace
1216 $text : Current text being indexed
1218 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
1219 $term : Search term string
1220 &$title : Outparam; set to $title object and return false for a match
1222 'SetupAfterCache': Called in Setup.php, after cache objects are set
1224 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1225 $text: Text being shown
1226 $title: Title of the custom script/stylesheet page
1227 $output: Current OutputPage object
1229 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1230 &$siteNotice: HTML returned as the sitenotice
1231 Return true to allow the normal method of notice selection/rendering to work,
1232 or change the value of $siteNotice and return false to alter it.
1234 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1235 &$siteNotice: HTML sitenotice
1236 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1238 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1240 &$text: bottomScripts Text
1241 Append to $text to add additional text/scripts after the stock bottom scripts.
1243 'SkinAfterContent': Allows extensions to add text after the page content and
1245 &$data: (string) Text to be printed out directly (without parsing)
1246 This hook should work in all skins. Just set the &$data variable to the text
1247 you're going to add.
1249 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1251 &$bar: Sidebar contents
1252 Modify $bar to add or modify sidebar portlets.
1254 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1255 $title: displayed page title
1256 $type: 'normal' or 'history' for old/diff views
1257 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1258 &$link: overridable HTML link to be passed into the message as $1
1260 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1262 &$subpages: Subpage links HTML
1263 If false is returned $subpages will be used instead of the HTML
1264 subPageSubtitle() generates.
1265 If true is returned, $subpages will be ignored and the rest of
1266 subPageSubtitle() will run.
1268 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab
1269 when showing a special page
1270 $sktemplate: SkinTemplate object
1271 $content_actions: array of tabs
1273 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1274 "permanent link" tab
1275 $sktemplate: SkinTemplate object
1276 $nav_urls: array of tabs
1278 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1279 &$content_actions: Content actions
1280 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1283 'SkinTemplateNavigation': Alter the structured navigation links in SkinTemplates
1284 &$sktemplate: SkinTemplate object
1285 &$links: Structured navigation links
1286 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1288 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1290 &$sktemplate: SkinTemplate object
1291 &$tpl: Template engine object
1293 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1294 $sktemplate: SkinTemplate object
1295 $res: set to true to prevent active tabs
1297 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1300 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1301 You can either create your own array, or alter the parameters for
1303 &$this: The SkinTemplate instance.
1304 $title: Title instance for the page.
1305 $message: Visible label of tab.
1306 $selected: Whether this is a selected tab.
1307 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1308 &$classes: Array of CSS classes to apply.
1309 &$query: Query string to add to link.
1311 &$result: Complete assoc. array if you want to return true.
1313 'SkinTemplateTabs': called when finished to build the actions tabs
1314 $sktemplate: SkinTemplate object
1315 $content_actions: array of tabs
1317 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1318 been rendered (useful for adding more)
1319 $tools: array of tools
1321 'SoftwareInfo': Called by Special:Version for returning information about
1323 $software: The array of software in format 'name' => 'version'.
1324 See SpecialVersion::softwareInformation()
1326 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1327 $id: User identifier
1329 'SpecialListusersDefaultQuery': called right before the end of
1330 UsersPager::getDefaultQuery()
1331 $pager: The UsersPager instance
1332 $query: The query array to be returned
1334 'SpecialListusersFormatRow': called right before the end of
1335 UsersPager::formatRow()
1336 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1337 $row: Database row object
1339 'SpecialListusersHeader': called before closing the <fieldset> in
1340 UsersPager::getPageHeader()
1341 $pager: The UsersPager instance
1342 $out: The header HTML
1344 'SpecialListusersHeaderForm': called before adding the submit button in
1345 UsersPager::getPageHeader()
1346 $pager: The UsersPager instance
1347 $out: The header HTML
1349 'SpecialListusersQueryInfo': called right before the end of
1350 UsersPager::getQueryInfo()
1351 $pager: The UsersPager instance
1352 $query: The query array to be returned
1354 'SpecialMovepageAfterMove': called after moving a page
1355 $movePage: MovePageForm object
1356 $oldTitle: old title (object)
1357 $newTitle: new title (object)
1359 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1360 hook to remove a core special page
1361 $list: list (array) of core special pages
1363 'SpecialRecentChangesPanel': called when building form options in
1364 SpecialRecentChanges
1365 &$extraOpts: array of added items, to which can be added
1366 $opts: FormOptions for this request
1368 'SpecialRecentChangesQuery': called when building sql query for
1369 SpecialRecentChanges
1370 &$conds: array of WHERE conditionals for query
1371 &$tables: array of tables to be queried
1372 &$join_conds: join conditions for the tables
1373 $opts: FormOptions for this request
1375 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1376 target doesn't exist
1377 $title: title object generated from the text entred by the user
1379 'SpecialSearchResults': called before search result display when there
1381 $term: string of search term
1382 &$titleMatches: empty or SearchResultSet object
1383 &$textMatches: empty or SearchResultSet object
1385 'SpecialSearchNoResults': called before search result display when there are
1387 $term: string of search term
1389 'SpecialUploadComplete': Called after successfully uploading a file from
1391 $form: The UploadForm object
1393 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1394 use this to change the tables headers
1395 $extTypes: associative array of extensions types
1397 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1398 &$conds: array of WHERE conditionals for query
1399 &$tables: array of tables to be queried
1400 &$join_conds: join conditions for the tables
1401 &$fields: array of query fields
1403 'TitleArrayFromResult': called when creating an TitleArray object from a
1405 &$titleArray: set this to an object to override the default object returned
1406 $res: database result used to create the object
1408 'TitleMoveComplete': after moving an article (title)
1411 $user: user who did the move
1412 $pageid: database ID of the page that's been moved
1413 $redirid: database ID of the created redirect
1415 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1416 $title: title object related to the revision
1417 $rev: revision (object) that will be viewed
1419 'UnknownAction': An unknown "action" has occured (useful for defining
1421 $action: action name
1422 $article: article "acted on"
1424 'UnwatchArticle': before a watch is removed from an article
1425 $user: user watching
1426 $article: article object to be removed
1428 'UnwatchArticle': after a watch is removed from an article
1429 $user: user that was watching
1430 $article: article object removed
1432 'UnwatchArticleComplete': after a watch is removed from an article
1433 $user: user that watched
1434 $article: article object that was watched
1436 'UploadForm:initial': before the upload form is generated
1437 $form: UploadForm object
1438 You might set the member-variables $uploadFormTextTop and
1439 $uploadFormTextAfterSummary to inject text (HTML) either before
1440 or after the editform.
1442 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1443 $form: UploadForm object
1444 Lets you poke at member variables like $mUploadDescription before the
1447 'UploadVerification': additional chances to reject an uploaded file
1448 string $saveName: destination file name
1449 string $tempName: filesystem path to the temporary file for checks
1450 string &$error: output: HTML error to show if upload canceled by returning false
1452 'UploadComplete': Upon completion of a file upload
1453 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1454 $uploadBase->getLocalFile().
1456 'User::mailPasswordInternal': before creation and mailing of a user's new
1458 $user: the user who sent the message out
1459 $ip: IP of the user who sent the message out
1460 $u: the account whose new password will be set
1462 'UserArrayFromResult': called when creating an UserArray object from a
1464 &$userArray: set this to an object to override the default object returned
1465 $res: database result used to create the object
1467 'userCan': To interrupt/advise the "user can do X to Y article" check.
1468 If you want to display an error message, try getUserPermissionsErrors.
1469 $title: Title object being checked against
1470 $user : Current user object
1471 $action: Action being checked
1472 $result: Pointer to result returned if hook returns false. If null is returned,
1473 userCan checks are continued by internal code.
1475 'UserCanSendEmail': To override User::canSendEmail() permission check
1476 $user: User (object) whose permission is being checked
1477 &$canSend: bool set on input, can override on output
1479 'UserClearNewTalkNotification': called when clearing the
1480 "You have new messages!" message, return false to not delete it
1481 $user: User (object) that'll clear the message
1483 'UserComparePasswords': called when checking passwords, return false to
1484 override the default password checks
1485 &$hash: String of the password hash (from the database)
1486 &$password: String of the plaintext password the user entered
1487 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1489 &$result: If the hook returns false, this Boolean value will be checked to
1490 determine if the password was valid
1492 'UserCreateForm': change to manipulate the login form
1493 $template: SimpleTemplate instance for the form
1495 'UserCryptPassword': called when hashing a password, return false to implement
1496 your own hashing method
1497 &$password: String of the plaintext password to encrypt
1498 &$salt: String of the password salt or Boolean false if no salt is provided
1499 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1501 &$hash: If the hook returns false, this String will be used as the hash
1503 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1504 $user: User to get groups for
1505 &$groups: Current effective groups
1507 'UserGetAllRights': after calculating a list of all available rights
1508 &$rights: Array of rights, which may be added to.
1510 'UserGetEmail': called when getting an user email address
1512 &$email: email, change this to override local email
1514 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1515 email authentification
1517 &$timestamp: timestamp, change this to override local email authentification
1520 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1521 &$groups: List of implicit (automatically-assigned) groups
1523 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1524 &$reservedUsernames: $wgReservedUsernames
1526 'UserGetRights': Called in User::getRights()
1527 $user: User to get rights for
1528 &$rights: Current rights
1530 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
1532 $ip: User's IP address
1533 &$blocked: Whether the user is blocked, to be modified by the hook
1535 'UserLoadAfterLoadFromSession': called to authenticate users on
1536 external/environmental means; occurs after session is loaded
1537 $user: user object being loaded
1539 'UserLoadDefaults': called when loading a default user
1543 'UserLoadFromDatabase': called when loading a user from the database
1545 &$s: database query object
1547 'UserLoadFromSession': called to authenticate users on external/environmental
1548 means; occurs before session is loaded
1549 $user: user object being loaded
1550 &$result: set this to a boolean value to abort the normal authentification
1553 'UserLoadOptions': when user options/preferences are being loaded from
1556 &$options: Options, can be modified.
1558 'UserLoginComplete': after a user has logged in
1559 $user: the user object that was created on login
1560 $inject_html: Any HTML to inject after the "logged in" message.
1562 'UserLoginForm': change to manipulate the login form
1563 $template: SimpleTemplate instance for the form
1565 'UserLoginMailPassword': Block users from emailing passwords
1566 $name: the username to email the password of.
1567 &$error: out-param - the error message to return.
1569 'UserLogout': before a user logs out
1570 $user: the user object that is about to be logged out
1572 'UserLogoutComplete': after a user has logged out
1573 $user: the user object _after_ logout (won't have name, ID, etc.)
1574 $inject_html: Any HTML to inject after the "logged out" message.
1575 $oldName: name of the user before logout (string)
1577 'UserRights': After a user's group memberships are changed
1578 $user : User object that was changed
1579 $add : Array of strings corresponding to groups added
1580 $remove: Array of strings corresponding to groups removed
1582 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
1584 $user: user retrieving new talks messages
1585 $talks: array of new talks page(s)
1587 'UserSaveSettings': called when saving user settings
1590 'UserSaveOptions': Called just before saving user preferences/options.
1592 &$options: Options, modifiable
1594 'UserSetCookies': called when setting user cookies
1596 &$session: session array, will be added to $_SESSION
1597 &$cookies: cookies array mapping cookie name to its value
1599 'UserSetEmail': called when changing user email address
1601 &$email: new email, change this to override new email address
1603 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
1604 of email authentification
1606 &$timestamp: new timestamp, change this to override local email
1607 authentification timestamp
1609 'UserToggles': called when initialising User::$mToggles, use this to add
1611 $toggles: array of toggles to add
1613 'VectorTemplateToolboxEnd': Called by Vector skin after toolbox links have
1614 been rendered (useful for adding more)
1615 Note: this is only run for the Vector skin. To add items to the toolbox
1616 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
1618 $tools: array of tools
1620 'WantedPages::getSQL': called in WantedPagesPage::getSQL(), can be used to
1621 alter the SQL query which gets the list of wanted pages
1622 &$wantedPages: WantedPagesPage object
1623 &$sql: raw SQL query used to get the list of wanted pages
1625 'WatchArticle': before a watch is added to an article
1626 $user: user that will watch
1627 $article: article object to be watched
1629 'WatchArticleComplete': after a watch is added to an article
1630 $user: user that watched
1631 $article: article object watched
1633 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
1635 One, and only one hook should set this, and return false.
1636 &$tables: Database tables to use in the SELECT query
1637 &$opts: Options to use for the query
1638 &$join: Join conditions
1640 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
1641 query pages to be updated with maintenance/updateSpecialPages.php
1642 $query: $wgQueryPages itself
1644 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
1645 metadata to be added.
1646 $obj: The XmlDumpWriter object.
1647 &$out: The output string.
1648 $row: The database row for the page.
1649 $title: The title of the page.
1651 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
1653 $obj: The XmlDumpWriter object.
1654 &$out: The text being output.
1655 $row: The database row for the revision.
1656 $text: The revision text.
1658 More hooks might be available but undocumented, you can execute
1659 ./maintenance/findhooks.php to find hidden one.