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 list=recentchanges.
328 Every token has an action, which will be used in the rctoken parameter
329 and in the output (actiontoken="..."), and a callback function which
330 should return the token, or false if the user isn't allowed to obtain
331 it. The prototype of the callback function is func($pageid, $title, $rc)
332 where $pageid is the page ID of the page associated to the revision the
333 token is requested for, $title the associated Title object and $rc the
334 associated RecentChange object. In the hook, just add your callback to the
335 $tokenFunctions array and return true (returning false makes no sense)
336 $tokenFunctions: array(action => callback)
338 'ArticleAfterFetchContent': after fetching content of an article from the database
339 $article: the article (object) being loaded from the database
340 $content: the content (string) of the article
342 'ArticleDelete': before an article is deleted
343 $article: the article (object) being deleted
344 $user: the user (object) deleting the article
345 $reason: the reason (string) the article is being deleted
346 $error: if the deletion was prohibited, the (raw HTML) error message to display
349 'ArticleDeleteComplete': after an article is deleted
350 $article: the article that was deleted
351 $user: the user that deleted the article
352 $reason: the reason the article was deleted
353 $id: id of the article that was deleted
355 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
356 $article: article (object) of the user talk page
358 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an article has been changed
359 $article: the article (object)
360 $editInfo: data holder that includes the parser output ($editInfo->output) for that page after the change
361 $changed: bool for if the page was changed
363 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
364 $article: article (object) being modified
366 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
367 $title: title (object) used to create the article object
368 $article: article (object) that will be returned
370 'ArticleInsertComplete': After a new article is created
371 $article: Article created
372 $user: User creating the article
374 $summary: Edit summary/comment
375 $isMinor: Whether or not the edit was marked as minor
376 $isWatch: (No longer used)
377 $section: (No longer used)
378 $flags: Flags passed to Article::doEdit()
379 $revision: New Revision of the article
381 'ArticleMergeComplete': after merging to article using Special:Mergehistory
382 $targetTitle: target title (object)
383 $destTitle: destination title (object)
385 'ArticlePageDataAfter': after loading data of an article from the database
386 $article: article (object) whose data were loaded
387 $row: row (object) returned from the database server
389 'ArticlePageDataBefore': before loading data of an article from the database
390 $article: article (object) that data will be loaded
391 $fields: fileds (array) to load from the database
393 'ArticleProtect': before an article is protected
394 $article: the article being protected
395 $user: the user doing the protection
396 $protect: boolean whether this is a protect or an unprotect
397 $reason: Reason for protect
398 $moveonly: boolean whether this is for move only or not
400 'ArticleProtectComplete': after an article is protected
401 $article: the article that was protected
402 $user: the user who did the protection
403 $protect: boolean whether it was a protect or an unprotect
404 $reason: Reason for protect
405 $moveonly: boolean whether it was for move only or not
407 'ArticlePurge': before executing "&action=purge"
408 $article: article (object) to purge
410 'ArticleRevisionVisiblitySet': called when changing visibility of one or more
411 revision of an article
412 &$title: title object of the article
414 'ArticleRevisionUndeleted': after an article revision is restored
415 $title: the article title
416 $revision: the revision
417 $oldPageID: the page ID of the revision when archived (may be null)
419 'ArticleRollbackComplete': after an article rollback is completed
420 $article: the article that was edited
421 $user: the user who did the rollback
422 $revision: the revision the page was reverted back to
424 'ArticleSave': before an article is saved
425 $article: the article (object) being saved
426 $user: the user (object) saving the article
427 $text: the new article text
428 $summary: the article summary (comment)
433 'ArticleSaveComplete': After an article has been updated
434 $article: Article modified
435 $user: User performing the modification
437 $summary: Edit summary/comment
438 $isMinor: Whether or not the edit was marked as minor
439 $isWatch: (No longer used)
440 $section: (No longer used)
441 $flags: Flags passed to Article::doEdit()
442 $revision: New Revision of the article
444 'ArticleUndelete': When one or more revisions of an article are restored
445 $title: Title corresponding to the article restored
446 $create: Whether or not the restoration caused the page to be created
447 (i.e. it didn't exist before)
449 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
450 &$article: the article
451 &$sectionanchor: The section anchor link (e.g. "#overview" )
452 &$extraq: Extra query parameters which can be added via hooked functions
454 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
455 &$article: the article
456 &$pcache: whether to try the parser cache or not
457 &$outputDone: whether the output for this page finished or not
459 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
460 $article: target article (object)
462 'AuthPluginAutoCreate': Called when creating a local account for an user logged
463 in from an external authentication method
464 $user: User object created locally
466 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
467 Gives a chance for an extension to set it programattically to a variable class.
468 &$auth: the $wgAuth object, probably a stub
470 'AutopromoteCondition': check autopromote condition for user.
471 $type: condition type
474 $result: result of checking autopromote condition
476 'BadImage': When checking against the bad image list
477 $name: Image name being checked
478 &$bad: Whether or not the image is "bad"
480 Change $bad and return false to override. If an image is "bad", it is not
481 rendered inline in wiki pages or galleries in category pages.
483 'BeforeGalleryFindFile': before an image is fetched for a gallery
484 &$gallery,: the gallery object
485 &$nt: the image title
486 &$time: image timestamp
488 'BeforePageDisplay': Prior to outputting a page
489 &$out: OutputPage object
492 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
493 &$parser: Parser object
494 &$title: title of the template
495 &$skip: skip this template and link it?
496 &$id: the id of the revision being parsed
498 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
499 &$parser: Parser object
500 &$nt: the image title
501 &$skip: skip this image and link it?
502 &$time: the image timestamp
504 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
505 &$parser: Parser object
506 &$ig: ImageGallery object
508 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
509 $nondefaults: Assoc array with the following keys:
510 days, hideOwn, hideBots, hideMinor, namespace
512 &$hookSql: a string which will be inserted without sanitation into the SQL query
513 used to get the watchlist, at the end of the WHERE part.
515 'BlockIp': before an IP address or user is blocked
516 $block: the Block object about to be saved
517 $user: the user _doing_ the block (not the one being blocked)
519 'BlockIpComplete': after an IP address or user is blocked
520 $block: the Block object that was saved
521 $user: the user who did the block (not the one being blocked)
523 'BookInformation': Before information output on Special:Booksources
524 $isbn: ISBN to show information for
525 $output: OutputPage object in use
527 'CategoryPageView': before viewing a categorypage in CategoryPage::view
528 $catpage: CategoryPage instance
530 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
531 &$this: ChangesList instance.
532 &$articlelink: HTML of link to article (already filled-in).
533 &$s: HTML of row that is being constructed.
534 &$rc: RecentChange instance.
535 $unpatrolled: Whether or not we are showing unpatrolled changes.
536 $watched: Whether or not the change is watched by the user.
538 'ContribsPager::getQueryInfo': Before the contributions query is about to run
539 &$pager: Pager object for contributions
540 &queryInfo: The query for the contribs Pager
542 'ContributionsLineEnding': Called before a contributions HTML line is finished
543 $page: SpecialPage object for contributions
545 $row: the DB row for this line
547 'ContributionsToolLinks': Change tool links above Special:Contributions
549 $title: User page title
550 &$tools: Array of tool links
552 'CustomEditor': When invoking the page editor
553 $article: Article being edited
554 $user: User performing the edit
556 Return true to allow the normal editor to be used, or false
557 if implementing a custom editor, e.g. for a special namespace,
560 'DiffViewHeader': called before diff display
561 $diff: DifferenceEngine object that's calling
562 $oldRev: Revision object of the "old" revision (may be null/invalid)
563 $newRev: Revision object of the "new" revision
565 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
566 $article: article (object) being viewed
567 $oldid: oldid (int) being viewed
569 'DoEditSectionLink': Override the HTML generated for section edit links
570 $skin: Skin object rendering the UI
571 $title: Title object for the title being linked to (may not be the same as
572 $wgTitle, if the section is included from a template)
573 $section: The designation of the section being pointed to, to be included in
574 the link, like "§ion=$section"
575 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
576 By default, this is wrapped in the 'editsectionhint' message.
577 $result: The HTML to return, prefilled with the default plus whatever other
578 changes earlier hooks have made
580 'EditFilter': Perform checks on an edit
581 $editor: Edit form (see includes/EditPage.php)
582 $text: Contents of the edit box
583 $section: Section being edited
584 &$error: Error message to return
585 $summary: Edit summary for page
587 'EditFilterMerged': Post-section-merge edit filter
588 $editor: EditPage instance (object)
589 $text: content of the edit box
590 $error: error message to return
591 $summary: Edit summary for page
593 'EditFormPreloadText': Allows population of the edit form when creating new pages
594 &$text: Text to preload with
595 &$title: Title object representing the page being created
597 'EditPage::attemptSave': called before an article is
598 saved, that is before insertNewArticle() is called
599 &$editpage_Obj: the current EditPage object
601 'EditPage::showEditForm:fields': allows injection of form field into edit form
602 &$editor: the EditPage instance for reference
603 &$out: an OutputPage instance to write to
604 return value is ignored (should always return true)
606 'EditPage::showEditForm:initial': before showing the edit form
607 $editor: EditPage instance (object)
609 Return false to halt editing; you'll need to handle error messages, etc. yourself.
610 Alternatively, modifying $error and returning true will cause the contents of $error
611 to be echoed at the top of the edit form as wikitext. Return true without altering
612 $error to allow the edit to proceed.
614 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
615 when there's an edit conflict. Return false to halt normal diff output; in
616 this case you're responsible for computing and outputting the entire "conflict"
617 part, i.e., the "difference between revisions" and "your text" headers and
619 &$editor: EditPage instance
620 &$out: OutputPage instance
622 'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form
623 &$editpage: The current EditPage object
624 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
625 &$tabindex: HTML tabindex of the last edit check/button
627 'EditPageBeforeEditChecks': allows modifying the edit checks below the textarea in the edit form
628 &$editpage: The current EditPage object
629 &$checks: Array of edit checks like "watch this page"/"minor edit"
630 &$tabindex: HTML tabindex of the last edit check/button
632 'EditSectionLink': Do not use, use DoEditSectionLink instead.
633 $skin: Skin rendering the UI
634 $title: Title being linked to
635 $section: Section to link to
637 $result: Result (alter this to override the generated links)
639 'EmailConfirmed': When checking that the user's email address is "confirmed"
640 $user: User being checked
641 $confirmed: Whether or not the email address is confirmed
642 This runs before the other checks, such as anonymity and the real check; return
643 true to allow those checks to occur, and false if checking is done.
645 'EmailUser': before sending email from one user to another
646 $to: address of receiving user
647 $from: address of sending user
648 $subject: subject of the mail
649 $text: text of the mail
651 'EmailUserComplete': after sending email from one user to another
652 $to: address of receiving user
653 $from: address of sending user
654 $subject: subject of the mail
655 $text: text of the mail
657 'FetchChangesList': When fetching the ChangesList derivative for a particular user
658 &$user: User the list is being fetched for
659 &$skin: Skin object to be used with the list
660 &$list: List object (defaults to NULL, change it to an object instance and return
661 false override the list derivative used)
663 'FileDeleteComplete': When a file is deleted
664 $file: reference to the deleted file
665 $oldimage: in case of the deletion of an old image, the name of the old file
666 $article: in case all revisions of the file are deleted a reference to the article
667 associated with the file.
668 $user: user who performed the deletion
671 'FileUpload': When a file upload occurs
672 $file : Image object representing the file that was uploaded
674 'FileUndeleteComplete': When a file is undeleted
675 $title: title object to the file
676 $fileVersions: array of undeleted versions. Empty if all versions were restored
677 $user: user who performed the undeletion
680 'GetAutoPromoteGroups': When determining which autopromote groups a user is entitled to be in.
681 &$user: user to promote.
682 &$promote: groups that will be added.
684 'GetBlockedStatus': after loading blocking status of an user from the database
685 $user: user (object) being checked
687 'GetCacheVaryCookies': get cookies that should vary cache options
688 $out: OutputPage object
689 &$cookies: array of cookies name, add a value to it if you want to add a cookie
690 that have to vary cache options
692 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
693 $title: Title object of page
694 $url: string value as output (out parameter, can modify)
695 $query: query options passed to Title::getFullURL()
697 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
698 $title: Title object of page
699 $url: string value as output (out parameter, can modify)
700 $query: query options passed to Title::getInternalURL()
702 'GetLinkColours': modify the CSS class of an array of page links
703 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
704 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
706 'GetLocalURL': modify local URLs as output into page links
707 $title: Title object of page
708 $url: string value as output (out parameter, can modify)
709 $query: query options passed to Title::getLocalURL()
711 'getUserPermissionsErrors': Add a permissions error when permissions errors are
712 checked for. Use instead of userCan for most cases. Return false if the
713 user can't do it, and populate $result with the reason in the form of
714 array( messagename, param1, param2, ... ). For consistency, error messages
715 should be plain text with no special coloring, bolding, etc. to show that
716 they're errors; presenting them properly to the user as errors is done by
718 $title: Title object being checked against
719 $user : Current user object
720 $action: Action being checked
721 $result: User permissions error to add. If none, return true.
723 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
724 if expensive checks are enabled.
726 'HTMLCacheUpdate::doUpdate': After cache invalidation updates are inserted into the job queue.
727 $title: Title object, pages linked to this title are purged.
729 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
730 image insertion. You can skip the default logic entirely by returning
731 false, or just modify a few things using call-by-reference.
733 &$title: Title object of the image
734 &$file: File object, or false if it doesn't exist
735 &$frameParams: Various parameters with special meanings; see documentation in
736 includes/Linker.php for Linker::makeImageLink2
737 &$handlerParams: Various parameters with special meanings; see documentation in
738 includes/Linker.php for Linker::makeImageLink2
739 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
740 &$res: Final HTML output, used if you return false
743 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
744 the image on an image page
745 $imagePage: ImagePage object ($this)
748 'ImagePageFileHistoryLine': called when a file history line is contructed
750 $line: the HTML of the history line
751 $css: the line CSS class
753 'ImagePageFindFile': called when fetching the file associated with an image page
754 $page: ImagePage object
756 &$displayFile: displayed File object
758 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
759 $title: Title object ($wgTitle)
761 $ignoreRedirect: boolean to skip redirect check
762 $target: Title/string of redirect target
764 'InitPreferencesForm': called at the end of PreferencesForm's constructor
765 $form: the PreferencesForm
766 $request: the web request to initialized from
768 'InternalParseBeforeLinks': during Parser's internalParse method before links but
769 after noinclude/includeonly/onlyinclude and other processing.
770 &$this: Parser object
771 &$text: string containing partially parsed text
772 &$this->mStripState: Parser's internal StripState object
774 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
775 $article: article (object) being checked
777 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
779 $result: Change this value to override the result of wfIsTrustedProxy()
781 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
782 tance to return false if the domain name doesn't match your organization
783 $addr: The e-mail address entered by the user
784 &$result: Set this and return false to override the internal checks
786 'isValidPassword': Override the result of User::isValidPassword()
787 $password: The password entered by the user
788 &$result: Set this and return false to override the internal checks
789 $user: User the password is being validated for
791 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
792 $magicExtensions: associative array of magic words synonyms
793 $lang: laguage code (string)
795 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
796 $specialPageAliases: associative array of magic words synonyms
797 $lang: laguage code (string)
799 'LinkBegin': Used when generating internal and interwiki links in
800 Linker::link(), before processing starts. Return false to skip default proces-
801 sing and return $ret. See documentation for Linker::link() for details on the
802 expected meanings of parameters.
803 $skin: the Skin object
804 $target: the Title that the link is pointing to
805 &$text: the contents that the <a> tag should have (raw HTML); null means "de-
807 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
808 tive array form, with keys and values unescaped. Should be merged with de-
809 fault values, with a value of false meaning to suppress the attribute.
810 &$query: the query string to add to the generated URL (the bit after the "?"),
811 in associative array form, with keys and values unescaped.
812 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
813 &$ret: the value to return if your hook returns false.
815 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
816 just before the function returns a value. If you return true, an <a> element
817 with HTML attributes $attribs and contents $text will be returned. If you re-
818 turn false, $ret will be returned.
819 $skin: the Skin object
820 $target: the Title object that the link is pointing to
821 $options: the options. Will always include either 'known' or 'broken', and may
823 &$text: the final (raw HTML) contents of the <a> tag, after processing.
824 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
826 &$ret: the value to return if your hook returns false.
828 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just before the return
830 &$alt: the image's alt text
831 &$img: the new image HTML (if returning false)
833 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just before the return
835 &$text: the link text
836 &$link: the new link HTML (if returning false)
838 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
839 &$linksUpdate: the LinkUpdate object
841 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
842 &$linksUpdate: the LinkUpdate object
844 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
845 &$linksUpdate: the LinkUpdate object
847 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
849 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
851 'LocalFile::getHistory': called before file history query performed
854 $fields: select fields
857 $join_conds: JOIN conditions
859 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
860 No return data is accepted; this hook is for auditing only.
861 $user: the User object being authenticated against
862 $password: the password being submitted and found wanting
863 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
865 'LogLine': Processes a single log entry on Special:Log
866 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
868 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
869 to logging.log_action database field.
870 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
871 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
872 appears to contain anything.
873 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
874 &$revert: string that is displayed in the UI, similar to $comment.
875 $time: timestamp of the log entry (added in 1.12)
877 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
878 &$type: array of strings
880 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
881 &$typeText: array of strings
883 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
884 &$headerText: array of strings
886 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
887 &$actionText: array of strings
889 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
890 $magicWords: array of strings
892 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
893 $variableIDs: array of strings
895 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript is executed
896 &$vars: variable (or multiple variables) to be added into the output
897 of Skin::makeVariablesScript
899 'MarkPatrolled': before an edit is marked patrolled
900 $rcid: ID of the revision to be marked patrolled
901 $user: the user (object) marking the revision as patrolled
902 $wcOnlySysopsCanPatrol: config setting indicating whether the user
903 needs to be a sysop in order to mark an edit patrolled
905 'MarkPatrolledComplete': after an edit is marked patrolled
906 $rcid: ID of the revision marked as patrolled
907 $user: user (object) who marked the edit patrolled
908 $wcOnlySysopsCanPatrol: config setting indicating whether the user
909 must be a sysop to patrol the edit
911 'MathAfterTexvc': after texvc is executed when rendering mathematics
912 $mathRenderer: instance of MathRenderer
913 $errmsg: error message, in HTML (string). Nonempty indicates failure
914 of rendering the formula
916 'MediaWikiPerformAction': Override MediaWiki::performAction().
917 Use this to do something completely different, after the basic
918 globals have been set up, but before ordinary actions take place.
924 $this: The $mediawiki object
926 'MessagesPreLoad': When loading a message from the database
927 $title: title of the message (string)
928 $message: value (string), change it to the message you want to define
930 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
931 Note: this is only run for the Monobook skin. To add items to the toolbox
932 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
934 $tools: array of tools
936 'NewRevisionFromEditComplete': called when a revision was inserted due to an edit
937 $article: the article edited
938 $rev: the new revision
939 $baseID: the revision ID this was based off, if any
940 $user: the editing user
942 'NormalizeMessageKey': Called before the software gets the text of a message
943 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets displayed
944 &$key: the message being looked up. Change this to something else to change what message gets displayed (string)
945 &$useDB: whether or not to look up the message in the database (bool)
946 &$langCode: the language code to get the message for (string) - or -
947 whether to use the content language (true) or site language (false) (bool)
948 &$transform: whether or not to expand variables and templates in the message (bool)
950 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
951 &$changeslist: The OldChangesList instance.
952 &$s: HTML of the form "<li>...</li>" containing one RC entry.
953 &$rc: The RecentChange object.
955 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
956 Hooks can alter or append to the array of URLs for search & suggestion formats.
957 &$urls: array of associative arrays with Url element attributes
959 'OutputPageBeforeHTML': a page has been processed by the parser and
960 the resulting HTML is about to be displayed.
961 $parserOutput: the parserOutput (object) that corresponds to the page
962 $text: the text that will be displayed, in HTML (string)
964 'OutputPageCheckLastModified': when checking if the page has been modified since the last visit
965 &$modifiedTimes: array of timestamps, the following keys are set: page, user, epoch
967 'OutputPageParserOutput': after adding a parserOutput to $wgOut
968 $out: OutputPage instance (object)
969 $parserOutput: parserOutput instance being added in $out
971 'OutputPageMakeCategoryLinks': links are about to be generated for the page's categories.
972 Implementations should return false if they generate the category links, so the default link generation is skipped.
973 $out: OutputPage instance (object)
974 $categories: associative array, keys are category names, values are category types ("normal" or "hidden")
975 $links: array, intended to hold the result. Must be an associative array with category types as keys and arrays of HTML links as values.
977 'PageHistoryBeforeList': When a history page list is about to be constructed.
978 $article: the article that the history is loading for
980 'PageHistoryLineEnding' : right before the end <li> is added to a history line
981 $row: the revision row for this line
982 $s: the string representing this parsed line
984 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is constructed
986 $queryInfo: the query parameters
988 'PageRenderingHash': alter the parser cache option hash key
989 A parser extension which depends on user options should install
990 this hook and append its values to the key.
991 $hash: reference to a hash key string which can be modified
993 'ParserAfterStrip': Same as ParserBeforeStrip
995 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
996 $parser: Parser object being used
997 $text: text that'll be returned
999 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1000 $parser: Parser object
1001 $text: text to parse
1002 $stripState: StripState instance being used
1004 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
1005 $parser: parser object
1006 $text: text being parsed
1007 $stripState: stripState used (object)
1009 'ParserBeforeTidy': called before tidy and custom tags replacements
1010 $parser: Parser object being used
1013 'ParserClearState': called at the end of Parser::clearState()
1014 $parser: Parser object being cleared
1016 'ParserFirstCallInit': called when the parser initialises for the first time
1017 &$parser: Parser object being cleared
1019 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
1020 $parser: Parser object
1021 $varCache: array to store the value in case of multiples calls of the same magic word
1022 $index: index (string) of the magic
1023 $ret: value of the magic word (the hook should set it)
1025 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
1026 $parser: Parser object
1027 $time: actual time (timestamp)
1029 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
1030 $parser: Parser object
1031 $varCache: varaiable cache (array)
1033 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
1034 $parser: Parser object
1035 $limitReport: text that will be included (without comment tags)
1037 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
1038 $title: title object representing the file
1039 $file: file object that will be used to create the image
1040 &$params: 2-D array of parameters
1042 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
1043 $parser: Parser object created
1045 'ParserTestTables': alter the list of tables to duplicate when parser tests
1046 are run. Use when page save hooks require the presence of custom tables
1047 to ensure that tests continue to run properly.
1048 &$tables: array of table names
1050 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1051 my talk page, my contributions" etc).
1053 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1054 &$title: Title object representing the current page
1056 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1057 &$user : User performing the action
1058 $action : Action being performed
1059 &$result : Whether or not the action should be prevented
1060 Change $result and return false to give a definitive answer, otherwise
1061 the built-in rate limiting checks are used, if enabled.
1063 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
1064 $form : PreferencesForm object
1065 &$html : HTML to append to
1067 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1068 AJAX search suggestions. Put results into &$results outparam and return false.
1069 $ns : array of int namespace keys to search in
1070 $search : search term (not guaranteed to be conveniently normalized)
1071 $limit : maximum number of results to return
1072 &$results : out param: array of page names (strings)
1074 'PrefsEmailAudit': called when user changes his email address
1075 $user: User (object) changing his email address
1076 $oldaddr: old email address (string)
1077 $newaddr: new email address (string)
1079 'PrefsPasswordAudit': called when user changes his password
1080 $user: User (object) changing his passoword
1081 $newPass: new password
1082 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1084 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1085 &$obj: RawPage object
1086 &$text: The text that's going to be the output
1088 'RecentChange_save': called at the end of RecenChange::save()
1089 $recentChange: RecentChange object
1091 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
1092 $form: the PreferencesForm
1093 $out: output page to render to, probably $wgOut
1095 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
1096 $form: the PreferencesForm
1097 $user: the User object to load preferences from
1099 'RevisionInsertComplete': called after a revision is inserted into the DB
1100 &$revision: the Revision
1101 $data: the data stored in old_text. The meaning depends on $flags: if external
1102 is set, it's the URL of the revision text in external storage; otherwise,
1103 it's the revision text itself. In either case, if gzip is set, the revision
1105 $flags: a comma-delimited list of strings representing the options used. May
1106 include: utf8 (this will always be set for new revisions); gzip; external.
1108 'SavePreferences': called at the end of PreferencesForm::savePreferences;
1109 returning false prevents the preferences from being saved.
1110 $form: the PreferencesForm
1111 $user: the User object to save preferences to
1112 $message: change this to set an error message (ignored if the hook does not return false)
1113 $old: old preferences of the user
1115 'SearchUpdate': Prior to search update completion
1117 $namespace : Page namespace
1119 $text : Current text being indexed
1121 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
1122 $term : Search term string
1123 &$title : Outparam; set to $title object and return false for a match
1125 'SetupAfterCache': Called in Setup.php, after cache objects are set
1127 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1128 $text: Text being shown
1129 $title: Title of the custom script/stylesheet page
1130 $output: Current OutputPage object
1132 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1133 &$siteNotice: HTML returned as the sitenotice
1134 Return true to allow the normal method of notice selection/rendering to work,
1135 or change the value of $siteNotice and return false to alter it.
1137 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1138 &$siteNotice: HTML sitenotice
1139 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1141 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1143 &$text: bottomScripts Text
1144 Append to $text to add additional text/scripts after the stock bottom scripts.
1146 'SkinAfterContent': Allows extensions to add text after the page content and
1148 &$data: (string) Text to be printed out directly (without parsing)
1149 This hook should work in all skins. Just set the &$data variable to the text
1150 you're going to add.
1152 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1154 &$bar: Sidebar contents
1155 Modify $bar to add or modify sidebar portlets.
1157 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1159 &$subpages: Subpage links HTML
1160 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
1161 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
1163 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
1164 $sktemplate: SkinTemplate object
1165 $content_actions: array of tabs
1167 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
1168 $sktemplate: SkinTemplate object
1169 $nav_urls: array of tabs
1171 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1172 &$content_actions: Content actions
1173 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1176 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
1177 &$sktemplate: SkinTemplate object
1178 &$tpl: Template engine object
1180 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1181 $sktemplate: SkinTemplate object
1182 $res: set to true to prevent active tabs
1184 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1187 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1188 You can either create your own array, or alter the parameters for the normal one.
1189 &$this: The SkinTemplate instance.
1190 $title: Title instance for the page.
1191 $message: Visible label of tab.
1192 $selected: Whether this is a selected tab.
1193 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1194 &$classes: Array of CSS classes to apply.
1195 &$query: Query string to add to link.
1197 &$result: Complete assoc. array if you want to return true.
1199 'SkinTemplateTabs': called when finished to build the actions tabs
1200 $sktemplate: SkinTemplate object
1201 $content_actions: array of tabs
1203 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have been rendered (useful for adding more)
1204 $tools: array of tools
1206 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1207 $id: User identifier
1209 'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
1210 $pager: The UsersPager instance
1211 $query: The query array to be returned
1213 'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
1214 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1215 $row: Database row object
1217 'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
1218 $pager: The UsersPager instance
1219 $out: The header HTML
1221 'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
1222 $pager: The UsersPager instance
1223 $out: The header HTML
1225 'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
1226 $pager: The UsersPager instance
1227 $query: The query array to be returned
1229 'SpecialMovepageAfterMove': called after moving a page
1230 $movePage: MovePageForm object
1231 $oldTitle: old title (object)
1232 $newTitle: new title (object)
1234 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
1235 $list: list (array) of core special pages
1237 'SpecialRecentChangesPanel': called when building form options in SpecialRecentChanges
1238 &$extraOpts: array of added items, to which can be added
1239 $opts: FormOptions for this request
1241 'SpecialRecentChangesQuery': called when building sql query for SpecialRecentChanges
1242 &$conds: array of where conditionals for query
1243 &$tables: array of tables to be queried
1244 &$join_conds: join conditions for the tables
1245 $opts: FormOptions for this request
1247 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
1248 $title: title object generated from the text entred by the user
1250 'SpecialSearchResults': called before search result display when there are matches
1251 $term: string of search term
1252 &$titleMatches: empty or SearchResultSet object
1253 &$textMatches: empty or SearchResultSet object
1255 'SpecialSearchNoResults': called before search result display when there are no matches
1256 $term: string of search term
1258 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1259 $extTypes: associative array of extensions types
1261 'TitleArrayFromResult': called when creating an TitleArray object from a database result
1262 &$titleArray: set this to an object to override the default object returned
1263 $res: database result used to create the object
1265 'TitleMoveComplete': after moving an article (title)
1268 $user: user who did the move
1269 $pageid: database ID of the page that's been moved
1270 $redirid: database ID of the created redirect
1272 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1273 $title: title object related to the revision
1274 $rev: revision (object) that will be viewed
1276 'UnknownAction': An unknown "action" has occured (useful for defining
1278 $action: action name
1279 $article: article "acted on"
1281 'UnwatchArticle': before a watch is removed from an article
1282 $user: user watching
1283 $article: article object to be removed
1285 'UnwatchArticle': after a watch is removed from an article
1286 $user: user that was watching
1287 $article: article object removed
1289 'UnwatchArticleComplete': after a watch is removed from an article
1290 $user: user that watched
1291 $article: article object that was watched
1293 'UploadForm:initial': before the upload form is generated
1294 $form: UploadForm object
1295 You might set the member-variables $uploadFormTextTop and
1296 $uploadFormTextAfterSummary to inject text (HTML) either before
1297 or after the editform.
1299 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1300 $form: UploadForm object
1301 Lets you poke at member variables like $mUploadDescription before the
1304 'UploadVerification': additional chances to reject an uploaded file
1305 string $saveName: destination file name
1306 string $tempName: filesystem path to the temporary file for checks
1307 string &$error: output: HTML error to show if upload canceled by returning false
1309 'UploadComplete': Upon completion of a file upload
1310 $uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
1312 'User::mailPasswordInternal': before creation and mailing of a user's new temporary password
1313 $user: the user who sent the message out
1314 $ip: IP of the user who sent the message out
1315 $u: the account whose new password will be set
1317 'UserArrayFromResult': called when creating an UserArray object from a database result
1318 &$userArray: set this to an object to override the default object returned
1319 $res: database result used to create the object
1321 'userCan': To interrupt/advise the "user can do X to Y article" check.
1322 If you want to display an error message, try getUserPermissionsErrors.
1323 $title: Title object being checked against
1324 $user : Current user object
1325 $action: Action being checked
1326 $result: Pointer to result returned if hook returns false. If null is returned,
1327 userCan checks are continued by internal code.
1329 'UserCanSendEmail': To override User::canSendEmail() permission check
1330 $user: User (object) whose permission is being checked
1331 &$canSend: bool set on input, can override on output
1334 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1335 $user: User (object) that'll clear the message
1337 'UserComparePasswords': called when checking passwords, return false to override the default password checks
1338 &$hash: String of the password hash (from the database)
1339 &$password: String of the plaintext password the user entered
1340 &$userId: Integer of the user's ID or Boolean false if the user ID was not supplied
1341 &$result: If the hook returns false, this Boolean value will be checked to determine if the password was valid
1343 'UserCreateForm': change to manipulate the login form
1344 $template: SimpleTemplate instance for the form
1346 'UserCryptPassword': called when hashing a password, return false to implement your own hashing method
1347 &$password: String of the plaintext password to encrypt
1348 &$salt: String of the password salt or Boolean false if no salt is provided
1349 &$wgPasswordSalt: Boolean of whether the salt is used in the default hashing method
1350 &$hash: If the hook returns false, this String will be used as the hash
1352 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1353 $user: User to get groups for
1354 &$groups: Current effective groups
1356 'UserGetAllRights': after calculating a list of all available rights
1357 &$rights: Array of rights, which may be added to.
1359 'UserGetEmail': called when getting an user email address
1361 &$email: email, change this to override local email
1363 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of email authentification
1365 &$timestamp: timestamp, change this to override local email authentification timestamp
1367 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1368 &$groups: List of implicit (automatically-assigned) groups
1370 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1371 *&$reservedUsernames: $wgReservedUsernames
1373 'UserGetRights': Called in User::getRights()
1374 $user: User to get rights for
1375 &$rights: Current rights
1377 'UserLoadDefaults': called when loading a default user
1381 'UserLoadFromSession': called to authenticate users on external/environmental means; occurs before session is loaded
1382 $user: user object being loaded
1383 &$result: set this to a boolean value to abort the normal authentification process
1385 'UserLoadAfterLoadFromSession': called to authenticate users on external/environmental means; occurs after session is loaded
1386 $user: user object being loaded
1388 'UserLoginComplete': after a user has logged in
1389 $user: the user object that was created on login
1390 $inject_html: Any HTML to inject after the "logged in" message.
1392 'UserLoginForm': change to manipulate the login form
1393 $template: SimpleTemplate instance for the form
1395 'UserLogout': before a user logs out
1396 $user: the user object that is about to be logged out
1398 'UserLogoutComplete': after a user has logged out
1399 $user: the user object _after_ logout (won't have name, ID, etc.)
1400 $inject_html: Any HTML to inject after the "logged out" message.
1401 $oldName: name of the user before logout (string)
1403 'UserRights': After a user's group memberships are changed
1404 $user : User object that was changed
1405 $add : Array of strings corresponding to groups added
1406 $remove: Array of strings corresponding to groups removed
1408 'UserrightsChangeableGroups': allows modification of the groups a user may add or remove via Special:UserRights
1409 $userrights : UserrightsPage object
1410 $user : User object of the current user
1411 $addergroups : Array of groups that the user is in
1412 &$groups : Array of groups that can be added or removed. In format of
1414 'add' => array( addablegroups ),
1415 'remove' => array( removablegroups ),
1416 'add-self' => array( addablegroups to self ),
1417 'remove-self' => array( removable groups from self )
1419 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1420 $user: user retrieving new talks messages
1421 $talks: array of new talks page(s)
1423 'UserSaveSettings': called when saving user settings
1426 'UserSetCookies': called when setting user cookies
1428 &$session: session array, will be added to $_SESSION
1429 &$cookies: cookies array mapping cookie name to its value
1431 'UserSetEmail': called when changing user email address
1433 &$email: new email, change this to override new email address
1435 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp of email authentification
1437 &$timestamp: new timestamp, change this to override local email authentification timestamp
1439 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1440 $toggles: array of toggles to add
1442 'WatchArticle': before a watch is added to an article
1443 $user: user that will watch
1444 $article: article object to be watched
1446 'WatchArticleComplete': after a watch is added to an article
1447 $user: user that watched
1448 $article: article object watched
1450 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1451 $query: $wgQueryPages itself
1453 More hooks might be available but undocumented, you can execute
1454 ./maintenance/findhooks.php to find hidden one.