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 'AbortLogin': Return false to cancel account login.
242 $user: the User object being authenticated against
243 $password: the password being submitted, not yet checked for validity
244 &$retval: a LoginForm class constant to return from authenticateUserData();
245 default is LoginForm::ABORTED. Note that the client may be using
246 a machine API rather than the HTML user interface.
248 'AbortMove': allows to abort moving an article (title)
251 $user: user who is doing the move
253 $reason: the reason for the move (added in 1.13)
255 'AbortNewAccount': Return false to cancel account creation.
256 $user: the User object about to be created (read-only, incomplete)
257 $message: out parameter: error message to display on abort
259 'AddNewAccount': after a user account is created
260 $user: the User object that was created. (Parameter added in 1.7)
261 $byEmail: true when account was created "by email" (added in 1.12)
263 'AjaxAddScript': Called in output page just before the initialisation
264 of the javascript ajax engine. The hook is only called when ajax
265 is enabled ( $wgUseAjax = true; ).
267 'AlternateEdit': before checking if an user can edit a page and
268 before showing the edit form ( EditPage::edit() ). This is triggered
270 $EditPage : the EditPage object
272 'APIAfterExecute': after calling the execute() method of an API module.
273 Use this to extend core API modules.
274 &$module: Module object
276 'APIEditBeforeSave': before saving a page with api.php?action=edit,
277 after processing request parameters. Return false to let the request
278 fail, returning an error message or an <edit result="Failure"> tag
279 if $resultArr was filled.
280 $EditPage : the EditPage object
281 $text : the new text of the article (has yet to be saved)
282 $resultArr : data in this array will be added to the API result
284 'APIGetAllowedParams': use this hook to modify a module's parameters.
285 &$module: Module object
286 &$params: Array of parameters
288 'APIGetParamDescription': use this hook to modify a module's parameter
290 &$module: Module object
291 &$desc: Array of parameter descriptions
293 'APIQueryAfterExecute': after calling the execute() method of an
294 action=query submodule. Use this to extend core API modules.
295 &$module: Module object
297 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
298 method of an action=query submodule. Use this to extend core API modules.
299 &$module: Module object
300 &$resultPageSet: ApiPageSet object
302 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
303 Every token has an action, which will be used in the intoken parameter
304 and in the output (actiontoken="..."), and a callback function which
305 should return the token, or false if the user isn't allowed to obtain
306 it. The prototype of the callback function is func($pageid, $title)
307 where $pageid is the page ID of the page the token is requested for
308 and $title is the associated Title object. In the hook, just add
309 your callback to the $tokenFunctions array and return true (returning
310 false makes no sense)
311 $tokenFunctions: array(action => callback)
313 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
314 Every token has an action, which will be used in the rvtoken parameter
315 and in the output (actiontoken="..."), and a callback function which
316 should return the token, or false if the user isn't allowed to obtain
317 it. The prototype of the callback function is func($pageid, $title, $rev)
318 where $pageid is the page ID of the page associated to the revision the
319 token is requested for, $title the associated Title object and $rev the
320 associated Revision object. In the hook, just add your callback to the
321 $tokenFunctions array and return true (returning false makes no sense)
322 $tokenFunctions: array(action => callback)
324 'APIQueryRecentChangesTokens': use this hook to add custom tokens to list=recentchanges.
325 Every token has an action, which will be used in the rctoken parameter
326 and in the output (actiontoken="..."), and a callback function which
327 should return the token, or false if the user isn't allowed to obtain
328 it. The prototype of the callback function is func($pageid, $title, $rc)
329 where $pageid is the page ID of the page associated to the revision the
330 token is requested for, $title the associated Title object and $rc the
331 associated RecentChange object. In the hook, just add your callback to the
332 $tokenFunctions array and return true (returning false makes no sense)
333 $tokenFunctions: array(action => callback)
335 'ArticleAfterFetchContent': after fetching content of an article from the database
336 $article: the article (object) being loaded from the database
337 $content: the content (string) of the article
339 'ArticleDelete': before an article is deleted
340 $article: the article (object) being deleted
341 $user: the user (object) deleting the article
342 $reason: the reason (string) the article is being deleted
343 $error: if the deletion was prohibited, the (raw HTML) error message to display
346 'ArticleDeleteComplete': after an article is deleted
347 $article: the article that was deleted
348 $user: the user that deleted the article
349 $reason: the reason the article was deleted
350 $id: id of the article that was deleted
352 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
353 $article: article (object) of the user talk page
355 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an article has been changed
356 $article: the article (object)
357 $editInfo: data holder that includes the parser output ($editInfo->output) for that page after the change
358 $changed: bool for if the page was changed
360 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
361 $article: article (object) being modified
363 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
364 $title: title (object) used to create the article object
365 $article: article (object) that will be returned
367 'ArticleInsertComplete': After a new article is created
368 $article: Article created
369 $user: User creating the article
371 $summary: Edit summary/comment
372 $isMinor: Whether or not the edit was marked as minor
373 $isWatch: (No longer used)
374 $section: (No longer used)
375 $flags: Flags passed to Article::doEdit()
376 $revision: New Revision of the article
378 'ArticleMergeComplete': after merging to article using Special:Mergehistory
379 $targetTitle: target title (object)
380 $destTitle: destination title (object)
382 'ArticlePageDataAfter': after loading data of an article from the database
383 $article: article (object) whose data were loaded
384 $row: row (object) returned from the database server
386 'ArticlePageDataBefore': before loading data of an article from the database
387 $article: article (object) that data will be loaded
388 $fields: fileds (array) to load from the database
390 'ArticleProtect': before an article is protected
391 $article: the article being protected
392 $user: the user doing the protection
393 $protect: boolean whether this is a protect or an unprotect
394 $reason: Reason for protect
395 $moveonly: boolean whether this is for move only or not
397 'ArticleProtectComplete': after an article is protected
398 $article: the article that was protected
399 $user: the user who did the protection
400 $protect: boolean whether it was a protect or an unprotect
401 $reason: Reason for protect
402 $moveonly: boolean whether it was for move only or not
404 'ArticlePurge': before executing "&action=purge"
405 $article: article (object) to purge
407 'ArticleRevisionVisiblitySet': called when changing visibility of one or more
408 revision of an article
409 &$title: title object of the article
411 'ArticleRevisionUndeleted': after an article revision is restored
412 $title: the article title
413 $revision: the revision
414 $oldPageID: the page ID of the revision when archived (may be null)
416 'ArticleRollbackComplete': after an article rollback is completed
417 $article: the article that was edited
418 $user: the user who did the rollback
419 $revision: the revision the page was reverted back to
421 'ArticleSave': before an article is saved
422 $article: the article (object) being saved
423 $user: the user (object) saving the article
424 $text: the new article text
425 $summary: the article summary (comment)
430 'ArticleSaveComplete': After an article has been updated
431 $article: Article modified
432 $user: User performing the modification
434 $summary: Edit summary/comment
435 $isMinor: Whether or not the edit was marked as minor
436 $isWatch: (No longer used)
437 $section: (No longer used)
438 $flags: Flags passed to Article::doEdit()
439 $revision: New Revision of the article
441 'ArticleUndelete': When one or more revisions of an article are restored
442 $title: Title corresponding to the article restored
443 $create: Whether or not the restoration caused the page to be created
444 (i.e. it didn't exist before)
446 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
447 &$article: the article
448 &$sectionanchor: The section anchor link (e.g. "#overview" )
449 &$extraq: Extra query parameters which can be added via hooked functions
451 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
452 &$article: the article
453 &$pcache: whether to try the parser cache or not
454 &$outputDone: whether the output for this page finished or not
456 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
457 $article: target article (object)
459 'AuthPluginAutoCreate': Called when creating a local account for an user logged
460 in from an external authentication method
461 $user: User object created locally
463 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
464 Gives a chance for an extension to set it programattically to a variable class.
465 &$auth: the $wgAuth object, probably a stub
467 'AutopromoteCondition': check autopromote condition for user.
468 $type: condition type
471 $result: result of checking autopromote condition
473 'BadImage': When checking against the bad image list
474 $name: Image name being checked
475 &$bad: Whether or not the image is "bad"
477 Change $bad and return false to override. If an image is "bad", it is not
478 rendered inline in wiki pages or galleries in category pages.
480 'BeforeGalleryFindFile': before an image is fetched for a gallery
481 &$gallery,: the gallery object
482 &$nt: the image title
483 &$time: image timestamp
485 'BeforePageDisplay': Prior to outputting a page
486 &$out: OutputPage object
489 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
490 &$parser: Parser object
491 &$title: title of the template
492 &$skip: skip this template and link it?
493 &$id: the id of the revision being parsed
495 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
496 &$parser: Parser object
497 &$nt: the image title
498 &$skip: skip this image and link it?
499 &$time: the image timestamp
501 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
502 &$parser: Parser object
503 &$ig: ImageGallery object
505 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
506 $nondefaults: Assoc array with the following keys:
507 days, hideOwn, hideBots, hideMinor, namespace
509 &$hookSql: a string which will be inserted without sanitation into the SQL query
510 used to get the watchlist, at the end of the WHERE part.
512 'BlockIp': before an IP address or user is blocked
513 $block: the Block object about to be saved
514 $user: the user _doing_ the block (not the one being blocked)
516 'BlockIpComplete': after an IP address or user is blocked
517 $block: the Block object that was saved
518 $user: the user who did the block (not the one being blocked)
520 'BookInformation': Before information output on Special:Booksources
521 $isbn: ISBN to show information for
522 $output: OutputPage object in use
524 'CategoryPageView': before viewing a categorypage in CategoryPage::view
525 $catpage: CategoryPage instance
527 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
528 &$this: ChangesList instance.
529 &$articlelink: HTML of link to article (already filled-in).
530 &$s: HTML of row that is being constructed.
531 &$rc: RecentChange instance.
532 $unpatrolled: Whether or not we are showing unpatrolled changes.
533 $watched: Whether or not the change is watched by the user.
535 'ContribsPager::getQueryInfo': Before the contributions query is about to run
536 &$pager: Pager object for contributions
537 &queryInfo: The query for the contribs Pager
539 'ContributionsLineEnding': Called before a contributions HTML line is finished
540 $page: SpecialPage object for contributions
542 $row: the DB row for this line
544 'ContributionsToolLinks': Change tool links above Special:Contributions
546 $title: User page title
547 &$tools: Array of tool links
549 'CustomEditor': When invoking the page editor
550 $article: Article being edited
551 $user: User performing the edit
553 Return true to allow the normal editor to be used, or false
554 if implementing a custom editor, e.g. for a special namespace,
557 'DiffViewHeader': called before diff display
558 $diff: DifferenceEngine object that's calling
559 $oldRev: Revision object of the "old" revision (may be null/invalid)
560 $newRev: Revision object of the "new" revision
562 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
563 $article: article (object) being viewed
564 $oldid: oldid (int) being viewed
566 'DoEditSectionLink': Override the HTML generated for section edit links
567 $skin: Skin object rendering the UI
568 $title: Title object for the title being linked to (may not be the same as
569 $wgTitle, if the section is included from a template)
570 $section: The designation of the section being pointed to, to be included in
571 the link, like "§ion=$section"
572 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
573 By default, this is wrapped in the 'editsectionhint' message.
574 $result: The HTML to return, prefilled with the default plus whatever other
575 changes earlier hooks have made
577 'EditFilter': Perform checks on an edit
578 $editor: Edit form (see includes/EditPage.php)
579 $text: Contents of the edit box
580 $section: Section being edited
581 &$error: Error message to return
582 $summary: Edit summary for page
584 'EditFilterMerged': Post-section-merge edit filter
585 $editor: EditPage instance (object)
586 $text: content of the edit box
587 $error: error message to return
588 $summary: Edit summary for page
590 'EditFormPreloadText': Allows population of the edit form when creating new pages
591 &$text: Text to preload with
592 &$title: Title object representing the page being created
594 'EditPage::attemptSave': called before an article is
595 saved, that is before insertNewArticle() is called
596 &$editpage_Obj: the current EditPage object
598 'EditPage::showEditForm:fields': allows injection of form field into edit form
599 &$editor: the EditPage instance for reference
600 &$out: an OutputPage instance to write to
601 return value is ignored (should always return true)
603 'EditPage::showEditForm:initial': before showing the edit form
604 $editor: EditPage instance (object)
606 Return false to halt editing; you'll need to handle error messages, etc. yourself.
607 Alternatively, modifying $error and returning true will cause the contents of $error
608 to be echoed at the top of the edit form as wikitext. Return true without altering
609 $error to allow the edit to proceed.
611 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
612 when there's an edit conflict. Return false to halt normal diff output; in
613 this case you're responsible for computing and outputting the entire "conflict"
614 part, i.e., the "difference between revisions" and "your text" headers and
616 &$editor: EditPage instance
617 &$out: OutputPage instance
619 'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form
620 &$editpage: The current EditPage object
621 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
623 'EditSectionLink': Do not use, use DoEditSectionLink instead.
624 $skin: Skin rendering the UI
625 $title: Title being linked to
626 $section: Section to link to
628 $result: Result (alter this to override the generated links)
630 'EmailConfirmed': When checking that the user's email address is "confirmed"
631 $user: User being checked
632 $confirmed: Whether or not the email address is confirmed
633 This runs before the other checks, such as anonymity and the real check; return
634 true to allow those checks to occur, and false if checking is done.
636 'EmailUser': before sending email from one user to another
637 $to: address of receiving user
638 $from: address of sending user
639 $subject: subject of the mail
640 $text: text of the mail
642 'EmailUserComplete': after sending email from one user to another
643 $to: address of receiving user
644 $from: address of sending user
645 $subject: subject of the mail
646 $text: text of the mail
648 'FetchChangesList': When fetching the ChangesList derivative for a particular user
649 &$user: User the list is being fetched for
650 &$skin: Skin object to be used with the list
651 &$list: List object (defaults to NULL, change it to an object instance and return
652 false override the list derivative used)
654 'FileDeleteComplete': When a file is deleted
655 $file: reference to the deleted file
656 $oldimage: in case of the deletion of an old image, the name of the old file
657 $article: in case all revisions of the file are deleted a reference to the article
658 associated with the file.
659 $user: user who performed the deletion
662 'FileUpload': When a file upload occurs
663 $file : Image object representing the file that was uploaded
665 'FileUndeleteComplete': When a file is undeleted
666 $title: title object to the file
667 $fileVersions: array of undeleted versions. Empty if all versions were restored
668 $user: user who performed the undeletion
671 'GetAutoPromoteGroups': When determining which autopromote groups a user is entitled to be in.
672 &$user: user to promote.
673 &$promote: groups that will be added.
675 'GetBlockedStatus': after loading blocking status of an user from the database
676 $user: user (object) being checked
678 'GetCacheVaryCookies': get cookies that should vary cache options
679 $out: OutputPage object
680 &$cookies: array of cookies name, add a value to it if you want to add a cookie
681 that have to vary cache options
683 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
684 $title: Title object of page
685 $url: string value as output (out parameter, can modify)
686 $query: query options passed to Title::getFullURL()
688 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
689 $title: Title object of page
690 $url: string value as output (out parameter, can modify)
691 $query: query options passed to Title::getInternalURL()
693 'GetLinkColours': modify the CSS class of an array of page links
694 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
695 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
697 'GetLocalURL': modify local URLs as output into page links
698 $title: Title object of page
699 $url: string value as output (out parameter, can modify)
700 $query: query options passed to Title::getLocalURL()
702 'getUserPermissionsErrors': Add a permissions error when permissions errors are
703 checked for. Use instead of userCan for most cases. Return false if the
704 user can't do it, and populate $result with the reason in the form of
705 array( messagename, param1, param2, ... ). For consistency, error messages
706 should be plain text with no special coloring, bolding, etc. to show that
707 they're errors; presenting them properly to the user as errors is done by
709 $title: Title object being checked against
710 $user : Current user object
711 $action: Action being checked
712 $result: User permissions error to add. If none, return true.
714 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
715 if expensive checks are enabled.
717 'HTMLCacheUpdate::doUpdate': After cache invalidation updates are inserted into the job queue.
718 $title: Title object, pages linked to this title are purged.
720 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
721 image insertion. You can skip the default logic entirely by returning
722 false, or just modify a few things using call-by-reference.
724 &$title: Title object of the image
725 &$file: File object, or false if it doesn't exist
726 &$frameParams: Various parameters with special meanings; see documentation in
727 includes/Linker.php for Linker::makeImageLink2
728 &$handlerParams: Various parameters with special meanings; see documentation in
729 includes/Linker.php for Linker::makeImageLink2
730 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
731 &$res: Final HTML output, used if you return false
734 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
735 the image on an image page
736 $imagePage: ImagePage object ($this)
739 'ImagePageFileHistoryLine': called when a file history line is contructed
741 $line: the HTML of the history line
742 $css: the line CSS class
744 'ImagePageFindFile': called when fetching the file associated with an image page
745 $page: ImagePage object
747 &$displayFile: displayed File object
749 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
750 $title: Title object ($wgTitle)
752 $ignoreRedirect: boolean to skip redirect check
753 $target: Title/string of redirect target
755 'InitPreferencesForm': called at the end of PreferencesForm's constructor
756 $form: the PreferencesForm
757 $request: the web request to initialized from
759 'InternalParseBeforeLinks': during Parser's internalParse method before links but
760 after noinclude/includeonly/onlyinclude and other processing.
761 &$this: Parser object
762 &$text: string containing partially parsed text
763 &$this->mStripState: Parser's internal StripState object
765 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
766 $article: article (object) being checked
768 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
770 $result: Change this value to override the result of wfIsTrustedProxy()
772 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
773 tance to return false if the domain name doesn't match your organization
774 $addr: The e-mail address entered by the user
775 &$result: Set this and return false to override the internal checks
777 'isValidPassword': Override the result of User::isValidPassword()
778 $password: The password entered by the user
779 &$result: Set this and return false to override the internal checks
780 $user: User the password is being validated for
782 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
783 $magicExtensions: associative array of magic words synonyms
784 $lang: laguage code (string)
786 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
787 $specialPageAliases: associative array of magic words synonyms
788 $lang: laguage code (string)
790 'LinkBegin': Used when generating internal and interwiki links in
791 Linker::link(), before processing starts. Return false to skip default proces-
792 sing and return $ret. See documentation for Linker::link() for details on the
793 expected meanings of parameters.
794 $skin: the Skin object
795 $target: the Title that the link is pointing to
796 &$text: the contents that the <a> tag should have (raw HTML); null means "de-
798 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
799 tive array form, with keys and values unescaped. Should be merged with de-
800 fault values, with a value of false meaning to suppress the attribute.
801 &$query: the query string to add to the generated URL (the bit after the "?"),
802 in associative array form, with keys and values unescaped.
803 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
804 &$ret: the value to return if your hook returns false.
806 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
807 just before the function returns a value. If you return true, an <a> element
808 with HTML attributes $attribs and contents $text will be returned. If you re-
809 turn false, $ret will be returned.
810 $skin: the Skin object
811 $target: the Title object that the link is pointing to
812 $options: the options. Will always include either 'known' or 'broken', and may
814 &$text: the final (raw HTML) contents of the <a> tag, after processing.
815 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
817 &$ret: the value to return if your hook returns false.
819 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just before the return
821 &$alt: the image's alt text
822 &$img: the new image HTML (if returning false)
824 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just before the return
826 &$text: the link text
827 &$link: the new link HTML (if returning false)
829 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
830 &$linksUpdate: the LinkUpdate object
832 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
833 &$linksUpdate: the LinkUpdate object
835 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
836 &$linksUpdate: the LinkUpdate object
838 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
840 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
842 'LocalFile::getHistory': called before file history query performed
845 $fields: select fields
848 $join_conds: JOIN conditions
850 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
851 No return data is accepted; this hook is for auditing only.
852 $user: the User object being authenticated against
853 $password: the password being submitted and found wanting
854 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
856 'LogLine': Processes a single log entry on Special:Log
857 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
859 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
860 to logging.log_action database field.
861 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
862 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
863 appears to contain anything.
864 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
865 &$revert: string that is displayed in the UI, similar to $comment.
866 $time: timestamp of the log entry (added in 1.12)
868 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
869 &$type: array of strings
871 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
872 &$typeText: array of strings
874 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
875 &$headerText: array of strings
877 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
878 &$actionText: array of strings
880 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
881 $magicWords: array of strings
883 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
884 $variableIDs: array of strings
886 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript is executed
887 &$vars: variable (or multiple variables) to be added into the output
888 of Skin::makeVariablesScript
890 'MarkPatrolled': before an edit is marked patrolled
891 $rcid: ID of the revision to be marked patrolled
892 $user: the user (object) marking the revision as patrolled
893 $wcOnlySysopsCanPatrol: config setting indicating whether the user
894 needs to be a sysop in order to mark an edit patrolled
896 'MarkPatrolledComplete': after an edit is marked patrolled
897 $rcid: ID of the revision marked as patrolled
898 $user: user (object) who marked the edit patrolled
899 $wcOnlySysopsCanPatrol: config setting indicating whether the user
900 must be a sysop to patrol the edit
902 'MathAfterTexvc': after texvc is executed when rendering mathematics
903 $mathRenderer: instance of MathRenderer
904 $errmsg: error message, in HTML (string). Nonempty indicates failure
905 of rendering the formula
907 'MediaWikiPerformAction': Override MediaWiki::performAction().
908 Use this to do something completely different, after the basic
909 globals have been set up, but before ordinary actions take place.
915 $this: The $mediawiki object
917 'MessagesPreLoad': When loading a message from the database
918 $title: title of the message (string)
919 $message: value (string), change it to the message you want to define
921 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
922 Note: this is only run for the Monobook skin. To add items to the toolbox
923 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
925 $tools: array of tools
927 'NewRevisionFromEditComplete': called when a revision was inserted due to an edit
928 $article: the article edited
929 $rev: the new revision
930 $baseID: the revision ID this was based off, if any
932 'NormalizeMessageKey': Called before the software gets the text of a message
933 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets displayed
934 &$key: the message being looked up. Change this to something else to change what message gets displayed (string)
935 &$useDB: whether or not to look up the message in the database (bool)
936 &$langCode: the language code to get the message for (string) - or -
937 whether to use the content language (true) or site language (false) (bool)
938 &$transform: whether or not to expand variables and templates in the message (bool)
940 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
941 &$changeslist: The OldChangesList instance.
942 &$s: HTML of the form "<li>...</li>" containing one RC entry.
943 &$rc: The RecentChange object.
945 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
946 Hooks can alter or append to the array of URLs for search & suggestion formats.
947 &$urls: array of associative arrays with Url element attributes
949 'OutputPageBeforeHTML': a page has been processed by the parser and
950 the resulting HTML is about to be displayed.
951 $parserOutput: the parserOutput (object) that corresponds to the page
952 $text: the text that will be displayed, in HTML (string)
954 'OutputPageCheckLastModified': when checking if the page has been modified since the last visit
955 &$modifiedTimes: array of timestamps, the following keys are set: page, user, epoch
957 'OutputPageParserOutput': after adding a parserOutput to $wgOut
958 $out: OutputPage instance (object)
959 $parserOutput: parserOutput instance being added in $out
961 'OutputPageMakeCategoryLinks': links are about to be generated for the page's categories.
962 Implementations should return false if they generate the category links, so the default link generation is skipped.
963 $out: OutputPage instance (object)
964 $categories: associative array, keys are category names, values are category types ("normal" or "hidden")
965 $links: array, intended to hold the result. Must be an associative array with category types as keys and arrays of HTML links as values.
967 'PageHistoryBeforeList': When a history page list is about to be constructed.
968 $article: the article that the history is loading for
970 'PageHistoryLineEnding' : right before the end <li> is added to a history line
971 $row: the revision row for this line
972 $s: the string representing this parsed line
974 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is constructed
976 $queryInfo: the query parameters
978 'PageRenderingHash': alter the parser cache option hash key
979 A parser extension which depends on user options should install
980 this hook and append its values to the key.
981 $hash: reference to a hash key string which can be modified
983 'ParserAfterStrip': Same as ParserBeforeStrip
985 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
986 $parser: Parser object being used
987 $text: text that'll be returned
989 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
990 $parser: Parser object
992 $stripState: StripState instance being used
994 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
995 $parser: parser object
996 $text: text being parsed
997 $stripState: stripState used (object)
999 'ParserBeforeTidy': called before tidy and custom tags replacements
1000 $parser: Parser object being used
1003 'ParserClearState': called at the end of Parser::clearState()
1004 $parser: Parser object being cleared
1006 'ParserFirstCallInit': called when the parser initialises for the first time
1007 &$parser: Parser object being cleared
1009 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
1010 $parser: Parser object
1011 $varCache: array to store the value in case of multiples calls of the same magic word
1012 $index: index (string) of the magic
1013 $ret: value of the magic word (the hook should set it)
1015 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
1016 $parser: Parser object
1017 $time: actual time (timestamp)
1019 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
1020 $parser: Parser object
1021 $varCache: varaiable cache (array)
1023 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
1024 $parser: Parser object
1025 $limitReport: text that will be included (without comment tags)
1027 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
1028 $title: title object representing the file
1029 $file: file object that will be used to create the image
1030 &$params: 2-D array of parameters
1032 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
1033 $parser: Parser object created
1035 'ParserTestTables': alter the list of tables to duplicate when parser tests
1036 are run. Use when page save hooks require the presence of custom tables
1037 to ensure that tests continue to run properly.
1038 &$tables: array of table names
1040 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1041 my talk page, my contributions" etc).
1043 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1044 &$title: Title object representing the current page
1046 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1047 &$user : User performing the action
1048 $action : Action being performed
1049 &$result : Whether or not the action should be prevented
1050 Change $result and return false to give a definitive answer, otherwise
1051 the built-in rate limiting checks are used, if enabled.
1053 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
1054 $form : PreferencesForm object
1055 &$html : HTML to append to
1057 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1058 AJAX search suggestions. Put results into &$results outparam and return false.
1059 $ns : array of int namespace keys to search in
1060 $search : search term (not guaranteed to be conveniently normalized)
1061 $limit : maximum number of results to return
1062 &$results : out param: array of page names (strings)
1064 'PrefsEmailAudit': called when user changes his email address
1065 $user: User (object) changing his email address
1066 $oldaddr: old email address (string)
1067 $newaddr: new email address (string)
1069 'PrefsPasswordAudit': called when user changes his password
1070 $user: User (object) changing his passoword
1071 $newPass: new password
1072 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1074 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1075 &$obj: RawPage object
1076 &$text: The text that's going to be the output
1078 'RecentChange_save': called at the end of RecenChange::save()
1079 $recentChange: RecentChange object
1081 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
1082 $form: the PreferencesForm
1083 $out: output page to render to, probably $wgOut
1085 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
1086 $form: the PreferencesForm
1087 $user: the User object to load preferences from
1089 'RevisionInsertComplete': called after a revision is inserted into the DB
1090 &$revision: the Revision
1091 $data: the data stored in old_text. The meaning depends on $flags: if external
1092 is set, it's the URL of the revision text in external storage; otherwise,
1093 it's the revision text itself. In either case, if gzip is set, the revision
1095 $flags: a comma-delimited list of strings representing the options used. May
1096 include: utf8 (this will always be set for new revisions); gzip; external.
1098 'SavePreferences': called at the end of PreferencesForm::savePreferences;
1099 returning false prevents the preferences from being saved.
1100 $form: the PreferencesForm
1101 $user: the User object to save preferences to
1102 $message: change this to set an error message (ignored if the hook does not return false)
1103 $old: old preferences of the user
1105 'SearchUpdate': Prior to search update completion
1107 $namespace : Page namespace
1109 $text : Current text being indexed
1111 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
1112 $term : Search term string
1113 &$title : Outparam; set to $title object and return false for a match
1115 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1116 $text: Text being shown
1117 $title: Title of the custom script/stylesheet page
1118 $output: Current OutputPage object
1120 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1121 &$siteNotice: HTML returned as the sitenotice
1122 Return true to allow the normal method of notice selection/rendering to work,
1123 or change the value of $siteNotice and return false to alter it.
1125 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1126 &$siteNotice: HTML sitenotice
1127 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1129 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1131 &$text: bottomScripts Text
1132 Append to $text to add additional text/scripts after the stock bottom scripts.
1134 'SkinAfterContent': Allows extensions to add text after the page content and
1136 &$data: (string) Text to be printed out directly (without parsing)
1137 This hook should work in all skins. Just set the &$data variable to the text
1138 you're going to add.
1140 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1142 &$bar: Sidebar contents
1143 Modify $bar to add or modify sidebar portlets.
1145 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1147 &$subpages: Subpage links HTML
1148 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
1149 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
1151 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
1152 $sktemplate: SkinTemplate object
1153 $content_actions: array of tabs
1155 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
1156 $sktemplate: SkinTemplate object
1157 $nav_urls: array of tabs
1159 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1160 &$content_actions: Content actions
1161 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1164 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
1165 &$sktemplate: SkinTemplate object
1166 &$tpl: Template engine object
1168 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1169 $sktemplate: SkinTemplate object
1170 $res: set to true to prevent active tabs
1172 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1175 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1176 You can either create your own array, or alter the parameters for the normal one.
1177 &$this: The SkinTemplate instance.
1178 $title: Title instance for the page.
1179 $message: Visible label of tab.
1180 $selected: Whether this is a selected tab.
1181 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1182 &$classes: Array of CSS classes to apply.
1183 &$query: Query string to add to link.
1185 &$result: Complete assoc. array if you want to return true.
1187 'SkinTemplateTabs': called when finished to build the actions tabs
1188 $sktemplate: SkinTemplate object
1189 $content_actions: array of tabs
1191 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have been rendered (useful for adding more)
1192 $tools: array of tools
1194 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1195 $id: User identifier
1197 'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
1198 $pager: The UsersPager instance
1199 $query: The query array to be returned
1201 'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
1202 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1203 $row: Database row object
1205 'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
1206 $pager: The UsersPager instance
1207 $out: The header HTML
1209 'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
1210 $pager: The UsersPager instance
1211 $out: The header HTML
1213 'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
1214 $pager: The UsersPager instance
1215 $query: The query array to be returned
1217 'SpecialMovepageAfterMove': called after moving a page
1218 $movePage: MovePageForm object
1219 $oldTitle: old title (object)
1220 $newTitle: new title (object)
1222 'SpecialPageExecuteAfterPage': called after executing a special page
1223 Warning: Not all the special pages call this hook
1224 $specialPage: SpecialPage object
1225 $par: paramter passed to the special page (string)
1226 $funct: function called to execute the special page
1228 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
1229 Warning: Not all the special pages call this hook
1230 $specialPage: SpecialPage object
1231 $par: paramter passed to the special page (string)
1232 $funct: function called to execute the special page
1234 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
1235 Warning: Not all the special pages call this hook
1236 $specialPage: SpecialPage object
1237 $par: paramter passed to the special page (string)
1238 $funct: function called to execute the special page
1240 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
1241 $list: list (array) of core special pages
1243 'SpecialRecentChangesPanel': called when building form options in SpecialRecentChanges
1244 &$extraOpts: array of added items, to which can be added
1245 $opts: FormOptions for this request
1247 'SpecialRecentChangesQuery': called when building sql query for SpecialRecentChanges
1248 &$conds: array of where conditionals for query
1249 &$tables: array of tables to be queried
1250 &$join_conds: join conditions for the tables
1251 $opts: FormOptions for this request
1253 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
1254 $title: title object generated from the text entred by the user
1256 'SpecialSearchResults': called before search result display when there are matches
1257 $term: string of search term
1258 &$titleMatches: empty or SearchResultSet object
1259 &$textMatches: empty or SearchResultSet object
1261 'SpecialSearchNoResults': called before search result display when there are no matches
1262 $term: string of search term
1264 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1265 $extTypes: associative array of extensions types
1267 'TitleArrayFromResult': called when creating an TitleArray object from a database result
1268 &$titleArray: set this to an object to override the default object returned
1269 $res: database result used to create the object
1271 'TitleMoveComplete': after moving an article (title)
1274 $user: user who did the move
1275 $pageid: database ID of the page that's been moved
1276 $redirid: database ID of the created redirect
1278 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1279 $title: title object related to the revision
1280 $rev: revision (object) that will be viewed
1282 'UnknownAction': An unknown "action" has occured (useful for defining
1284 $action: action name
1285 $article: article "acted on"
1287 'UnwatchArticle': before a watch is removed from an article
1288 $user: user watching
1289 $article: article object to be removed
1291 'UnwatchArticle': after a watch is removed from an article
1292 $user: user that was watching
1293 $article: article object removed
1295 'UnwatchArticleComplete': after a watch is removed from an article
1296 $user: user that watched
1297 $article: article object that was watched
1299 'UploadForm:initial': before the upload form is generated
1300 $form: UploadForm object
1301 You might set the member-variables $uploadFormTextTop and
1302 $uploadFormTextAfterSummary to inject text (HTML) either before
1303 or after the editform.
1305 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1306 $form: UploadForm object
1307 Lets you poke at member variables like $mUploadDescription before the
1310 'UploadVerification': additional chances to reject an uploaded file
1311 string $saveName: destination file name
1312 string $tempName: filesystem path to the temporary file for checks
1313 string &$error: output: HTML error to show if upload canceled by returning false
1315 'UploadComplete': Upon completion of a file upload
1316 $uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
1318 'User::mailPasswordInternal': before creation and mailing of a user's new temporary password
1319 $user: the user who sent the message out
1320 $ip: IP of the user who sent the message out
1321 $u: the account whose new password will be set
1323 'UserArrayFromResult': called when creating an UserArray object from a database result
1324 &$userArray: set this to an object to override the default object returned
1325 $res: database result used to create the object
1327 'userCan': To interrupt/advise the "user can do X to Y article" check.
1328 If you want to display an error message, try getUserPermissionsErrors.
1329 $title: Title object being checked against
1330 $user : Current user object
1331 $action: Action being checked
1332 $result: Pointer to result returned if hook returns false. If null is returned,
1333 userCan checks are continued by internal code.
1335 'UserCanSendEmail': To override User::canSendEmail() permission check
1336 $user: User (object) whose permission is being checked
1337 &$canSend: bool set on input, can override on output
1340 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1341 $user: User (object) that'll clear the message
1343 'UserCreateForm': change to manipulate the login form
1344 $template: SimpleTemplate instance for the form
1346 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1347 $user: User to get groups for
1348 &$groups: Current effective groups
1350 'UserGetAllRights': after calculating a list of all available rights
1351 &$rights: Array of rights, which may be added to.
1353 'UserGetEmail': called when getting an user email address
1355 &$email: email, change this to override local email
1357 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of email authentification
1359 &$timestamp: timestamp, change this to override local email authentification timestamp
1361 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1362 &$groups: List of implicit (automatically-assigned) groups
1364 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1365 *&$reservedUsernames: $wgReservedUsernames
1367 'UserGetRights': Called in User::getRights()
1368 $user: User to get rights for
1369 &$rights: Current rights
1371 'UserLoadDefaults': called when loading a default user
1375 'UserLoadFromSession': called to authenticate users on external/environmental means
1376 $user: user object being loaded
1377 &$result: set this to a boolean value to abort the normal authentification process
1379 'UserLoginComplete': after a user has logged in
1380 $user: the user object that was created on login
1381 $inject_html: Any HTML to inject after the "logged in" message.
1383 'UserLoginForm': change to manipulate the login form
1384 $template: SimpleTemplate instance for the form
1386 'UserLogout': before a user logs out
1387 $user: the user object that is about to be logged out
1389 'UserLogoutComplete': after a user has logged out
1390 $user: the user object _after_ logout (won't have name, ID, etc.)
1391 $inject_html: Any HTML to inject after the "logged out" message.
1392 $oldName: name of the user before logout (string)
1394 'UserRights': After a user's group memberships are changed
1395 $user : User object that was changed
1396 $add : Array of strings corresponding to groups added
1397 $remove: Array of strings corresponding to groups removed
1399 'UserrightsChangeableGroups': allows modification of the groups a user may add or remove via Special:UserRights
1400 $userrights : UserrightsPage object
1401 $user : User object of the current user
1402 $addergroups : Array of groups that the user is in
1403 &$groups : Array of groups that can be added or removed. In format of
1405 'add' => array( addablegroups ),
1406 'remove' => array( removablegroups ),
1407 'add-self' => array( addablegroups to self ),
1408 'remove-self' => array( removable groups from self )
1411 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1412 $user: user retrieving new talks messages
1413 $talks: array of new talks page(s)
1415 'UserSaveSettings': called when saving user settings
1418 'UserSetCookies': called when setting user cookies
1420 &$session: session array, will be added to $_SESSION
1421 &$cookies: cookies array mapping cookie name to its value
1423 'UserSetEmail': called when changing user email address
1425 &$email: new email, change this to override new email address
1427 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp of email authentification
1429 &$timestamp: new timestamp, change this to override local email authentification timestamp
1431 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1432 $toggles: array of toggles to add
1434 'WatchArticle': before a watch is added to an article
1435 $user: user that will watch
1436 $article: article object to be watched
1438 'WatchArticleComplete': after a watch is added to an article
1439 $user: user that watched
1440 $article: article object watched
1442 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1443 $query: $wgQueryPages itself
1445 More hooks might be available but undocumented, you can execute
1446 ./maintenance/findhooks.php to find hidden one.