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 'AbortNewAccountAuto': Return false to cancel account creation when the
263 request is coming from an AuthPlugin or ExtUser, rather than a
264 manually-submitted CreateAccount form.
265 $user: the User object about to be created (read-only, incomplete)
266 $message: out parameter: error message to display on abort
268 'AddNewAccount': after a user account is created
269 $user: the User object that was created. (Parameter added in 1.7)
270 $byEmail: true when account was created "by email" (added in 1.12)
272 'AjaxAddScript': Called in output page just before the initialisation
273 of the javascript ajax engine. The hook is only called when ajax
274 is enabled ( $wgUseAjax = true; ).
276 'AlternateEdit': before checking if an user can edit a page and
277 before showing the edit form ( EditPage::edit() ). This is triggered
279 $EditPage: the EditPage object
281 'APIAfterExecute': after calling the execute() method of an API module.
282 Use this to extend core API modules.
283 &$module: Module object
285 'APIEditBeforeSave': before saving a page with api.php?action=edit,
286 after processing request parameters. Return false to let the request
287 fail, returning an error message or an <edit result="Failure"> tag
288 if $resultArr was filled.
289 $EditPage : the EditPage object
290 $text : the new text of the article (has yet to be saved)
291 &$resultArr : data in this array will be added to the API result
293 'APIGetAllowedParams': use this hook to modify a module's parameters.
294 &$module: Module object
295 &$params: Array of parameters
297 'APIGetParamDescription': use this hook to modify a module's parameter
299 &$module: Module object
300 &$desc: Array of parameter descriptions
302 'APIQueryAfterExecute': after calling the execute() method of an
303 action=query submodule. Use this to extend core API modules.
304 &$module: Module object
306 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
307 method of an action=query submodule. Use this to extend core API modules.
308 &$module: Module object
309 &$resultPageSet: ApiPageSet object
311 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
312 Every token has an action, which will be used in the intoken parameter
313 and in the output (actiontoken="..."), and a callback function which
314 should return the token, or false if the user isn't allowed to obtain
315 it. The prototype of the callback function is func($pageid, $title)
316 where $pageid is the page ID of the page the token is requested for
317 and $title is the associated Title object. In the hook, just add
318 your callback to the $tokenFunctions array and return true (returning
319 false makes no sense)
320 $tokenFunctions: array(action => callback)
322 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
323 Every token has an action, which will be used in the rvtoken parameter
324 and in the output (actiontoken="..."), and a callback function which
325 should return the token, or false if the user isn't allowed to obtain
326 it. The prototype of the callback function is func($pageid, $title, $rev)
327 where $pageid is the page ID of the page associated to the revision the
328 token is requested for, $title the associated Title object and $rev the
329 associated Revision object. In the hook, just add your callback to the
330 $tokenFunctions array and return true (returning false makes no sense)
331 $tokenFunctions: array(action => callback)
333 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
335 Every token has an action, which will be used in the rctoken parameter
336 and in the output (actiontoken="..."), and a callback function which
337 should return the token, or false if the user isn't allowed to obtain
338 it. The prototype of the callback function is func($pageid, $title, $rc)
339 where $pageid is the page ID of the page associated to the revision the
340 token is requested for, $title the associated Title object and $rc the
341 associated RecentChange object. In the hook, just add your callback to the
342 $tokenFunctions array and return true (returning false makes no sense)
343 $tokenFunctions: array(action => callback)
345 'APIQueryUsersTokens': use this hook to add custom token to list=users.
346 Every token has an action, which will be used in the ustoken parameter
347 and in the output (actiontoken="..."), and a callback function which
348 should return the token, or false if the user isn't allowed to obtain
349 it. The prototype of the callback function is func($user) where $user
350 is the User object. In the hook, just add your callback to the
351 $tokenFunctions array and return true (returning false makes no sense)
352 $tokenFunctions: array(action => callback)
354 'ArticleAfterFetchContent': after fetching content of an article from
356 $article: the article (object) being loaded from the database
357 $content: the content (string) of the article
359 'ArticleDelete': before an article is deleted
360 $article: the article (object) being deleted
361 $user: the user (object) deleting the article
362 $reason: the reason (string) the article is being deleted
363 $error: if the deletion was prohibited, the (raw HTML) error message to display
366 'ArticleDeleteComplete': after an article is deleted
367 $article: the article that was deleted
368 $user: the user that deleted the article
369 $reason: the reason the article was deleted
370 $id: id of the article that was deleted
372 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
374 $article: article (object) of the user talk page
376 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
377 article has been changed
378 $article: the article (object)
379 $editInfo: data holder that includes the parser output ($editInfo->output) for
380 that page after the change
381 $changed: bool for if the page was changed
383 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
384 recentchanges table, return false to not delete old entries
385 $article: article (object) being modified
387 'ArticleFromTitle': when creating an article object from a title object using
388 Wiki::articleFromTitle()
389 $title: title (object) used to create the article object
390 $article: article (object) that will be returned
392 'ArticleInsertComplete': After a new article is created
393 $article: Article created
394 $user: User creating the article
396 $summary: Edit summary/comment
397 $isMinor: Whether or not the edit was marked as minor
398 $isWatch: (No longer used)
399 $section: (No longer used)
400 $flags: Flags passed to Article::doEdit()
401 $revision: New Revision of the article
403 'ArticleMergeComplete': after merging to article using Special:Mergehistory
404 $targetTitle: target title (object)
405 $destTitle: destination title (object)
407 'ArticlePageDataAfter': after loading data of an article from the database
408 $article: article (object) whose data were loaded
409 $row: row (object) returned from the database server
411 'ArticlePageDataBefore': before loading data of an article from the database
412 $article: article (object) that data will be loaded
413 $fields: fileds (array) to load from the database
415 'ArticleProtect': before an article is protected
416 $article: the article being protected
417 $user: the user doing the protection
418 $protect: boolean whether this is a protect or an unprotect
419 $reason: Reason for protect
420 $moveonly: boolean whether this is for move only or not
422 'ArticleProtectComplete': after an article is protected
423 $article: the article that was protected
424 $user: the user who did the protection
425 $protect: boolean whether it was a protect or an unprotect
426 $reason: Reason for protect
427 $moveonly: boolean whether it was for move only or not
429 'ArticlePurge': before executing "&action=purge"
430 $article: article (object) to purge
432 'ArticleRevisionVisiblitySet': called when changing visibility of one or more
433 revision of an article
434 &$title: title object of the article
436 'ArticleRevisionUndeleted': after an article revision is restored
437 $title: the article title
438 $revision: the revision
439 $oldPageID: the page ID of the revision when archived (may be null)
441 'ArticleRollbackComplete': after an article rollback is completed
442 $article: the article that was edited
443 $user: the user who did the rollback
444 $revision: the revision the page was reverted back to
445 $current: the reverted revision
447 'ArticleSave': before an article is saved
448 $article: the article (object) being saved
449 $user: the user (object) saving the article
450 $text: the new article text
451 $summary: the article summary (comment)
456 'ArticleSaveComplete': After an article has been updated
457 $article: Article modified
458 $user: User performing the modification
460 $summary: Edit summary/comment
461 $isMinor: Whether or not the edit was marked as minor
462 $isWatch: (No longer used)
463 $section: (No longer used)
464 $flags: Flags passed to Article::doEdit()
465 $revision: New Revision of the article
466 $baseRevId: the rev ID (or false) this edit was based on
468 'ArticleUndelete': When one or more revisions of an article are restored
469 $title: Title corresponding to the article restored
470 $create: Whether or not the restoration caused the page to be created
471 (i.e. it didn't exist before)
472 $comment: The comment associated with the undeletion.
474 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
475 before the user is redirected back to the page
476 &$article: the article
477 &$sectionanchor: The section anchor link (e.g. "#overview" )
478 &$extraq: Extra query parameters which can be added via hooked functions
480 'ArticleViewHeader': Before the parser cache is about to be tried for article
482 &$article: the article
483 &$pcache: whether to try the parser cache or not
484 &$outputDone: whether the output for this page finished or not
486 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
488 $article: target article (object)
490 'AuthPluginAutoCreate': Called when creating a local account for an user logged
491 in from an external authentication method
492 $user: User object created locally
494 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
495 Gives a chance for an extension to set it programattically to a variable class.
496 &$auth: the $wgAuth object, probably a stub
498 'AutopromoteCondition': check autopromote condition for user.
499 $type: condition type
502 $result: result of checking autopromote condition
504 'BadImage': When checking against the bad image list
505 $name: Image name being checked
506 &$bad: Whether or not the image is "bad"
508 Change $bad and return false to override. If an image is "bad", it is not
509 rendered inline in wiki pages or galleries in category pages.
511 'BeforeGalleryFindFile': before an image is fetched for a gallery
512 &$gallery,: the gallery object
513 &$nt: the image title
514 &$time: image timestamp
516 'BeforeInitialize': before anything is initialized in performRequestForTitle()
517 &$title: Title being used for request
518 &$article: The associated Article object
519 &$output: OutputPage object
521 $request: WebRequest object
522 $this: Mediawiki object
524 'BeforePageDisplay': Prior to outputting a page
525 &$out: OutputPage object
528 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
529 &$parser: Parser object
530 &$title: title of the template
531 &$skip: skip this template and link it?
532 &$id: the id of the revision being parsed
534 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
535 &$parser: Parser object
536 &$nt: the image title
537 &$skip: skip this image and link it?
538 &$time: the image timestamp
540 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
541 &$parser: Parser object
542 &$ig: ImageGallery object
544 'BlockIp': before an IP address or user is blocked
545 $block: the Block object about to be saved
546 $user: the user _doing_ the block (not the one being blocked)
548 'BlockIpComplete': after an IP address or user is blocked
549 $block: the Block object that was saved
550 $user: the user who did the block (not the one being blocked)
552 'BookInformation': Before information output on Special:Booksources
553 $isbn: ISBN to show information for
554 $output: OutputPage object in use
556 'CategoryPageView': before viewing a categorypage in CategoryPage::view
557 $catpage: CategoryPage instance
559 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
560 &$this: ChangesList instance.
561 &$articlelink: HTML of link to article (already filled-in).
562 &$s: HTML of row that is being constructed.
563 &$rc: RecentChange instance.
564 $unpatrolled: Whether or not we are showing unpatrolled changes.
565 $watched: Whether or not the change is watched by the user.
567 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
568 $user: user (object) whose email is being confirmed
570 'ContribsPager::getQueryInfo': Before the contributions query is about to run
571 &$pager: Pager object for contributions
572 &queryInfo: The query for the contribs Pager
574 'ContributionsLineEnding': Called before a contributions HTML line is finished
575 $page: SpecialPage object for contributions
577 $row: the DB row for this line
579 'ContributionsToolLinks': Change tool links above Special:Contributions
581 $title: User page title
582 &$tools: Array of tool links
584 'CustomEditor': When invoking the page editor
585 $article: Article being edited
586 $user: User performing the edit
588 Return true to allow the normal editor to be used, or false
589 if implementing a custom editor, e.g. for a special namespace,
592 'DatabaseOraclePostInit': Called after initialising an Oracle database
593 &$db: the DatabaseOracle object
595 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
596 $title: the diff page title (nullable)
597 &$oldId: the actual old Id to use in the diff
598 &$newId: the actual new Id to use in the diff (0 means current)
599 $old: the ?old= param value from the url
600 $new: the ?new= param value from the url
602 'DiffViewHeader': called before diff display
603 $diff: DifferenceEngine object that's calling
604 $oldRev: Revision object of the "old" revision (may be null/invalid)
605 $newRev: Revision object of the "new" revision
607 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
609 $article: article (object) being viewed
610 $oldid: oldid (int) being viewed
612 'DoEditSectionLink': Override the HTML generated for section edit links
613 $skin: Skin object rendering the UI
614 $title: Title object for the title being linked to (may not be the same as
615 $wgTitle, if the section is included from a template)
616 $section: The designation of the section being pointed to, to be included in
617 the link, like "§ion=$section"
618 $tooltip: The default tooltip. Escape with htmlspecialchars() before using.
619 By default, this is wrapped in the 'editsectionhint' message.
620 $result: The HTML to return, prefilled with the default plus whatever other
621 changes earlier hooks have made
623 'EditFilter': Perform checks on an edit
624 $editor: Edit form (see includes/EditPage.php)
625 $text: Contents of the edit box
626 $section: Section being edited
627 &$error: Error message to return
628 $summary: Edit summary for page
630 'EditFilterMerged': Post-section-merge edit filter
631 $editor: EditPage instance (object)
632 $text: content of the edit box
633 &$error: error message to return
634 $summary: Edit summary for page
636 'EditFormPreloadText': Allows population of the edit form when creating
638 &$text: Text to preload with
639 &$title: Title object representing the page being created
641 'EditPage::attemptSave': called before an article is
642 saved, that is before insertNewArticle() is called
643 $editpage_Obj: the current EditPage object
645 'EditPage::importFormData': allow extensions to read additional data
647 $editpage: EditPage instance
649 return value is ignored (should always return true)
651 'EditPage::showEditForm:fields': allows injection of form field into edit form
652 &$editor: the EditPage instance for reference
653 &$out: an OutputPage instance to write to
654 return value is ignored (should always return true)
656 'EditPage::showEditForm:initial': before showing the edit form
657 $editor: EditPage instance (object)
659 Return false to halt editing; you'll need to handle error messages, etc.
660 yourself. Alternatively, modifying $error and returning true will cause the
661 contents of $error to be echoed at the top of the edit form as wikitext.
662 Return true without altering $error to allow the edit to proceed.
664 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
665 when there's an edit conflict. Return false to halt normal diff output; in
666 this case you're responsible for computing and outputting the entire "conflict"
667 part, i.e., the "difference between revisions" and "your text" headers and
669 &$editor: EditPage instance
670 &$out: OutputPage instance
672 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
673 textarea in the edit form
674 &$editpage: The current EditPage object
675 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
676 &$tabindex: HTML tabindex of the last edit check/button
678 'EditPageBeforeEditChecks': allows modifying the edit checks below the
679 textarea in the edit form
680 &$editpage: The current EditPage object
681 &$checks: Array of edit checks like "watch this page"/"minor edit"
682 &$tabindex: HTML tabindex of the last edit check/button
684 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
685 textarea in the edit form
686 &$toolbar: The toolbar HTMl
688 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
689 $title: title of page being edited
690 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
692 'EditPageTosSummary': Give a chance for site and per-namespace customizations
693 of terms of service summary link that might exist separately from the copyright
695 $title: title of page being edited
696 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
698 'EditSectionLink': Do not use, use DoEditSectionLink instead.
699 $skin: Skin rendering the UI
700 $title: Title being linked to
701 $section: Section to link to
703 $result: Result (alter this to override the generated links)
705 'EmailConfirmed': When checking that the user's email address is "confirmed"
706 $user: User being checked
707 $confirmed: Whether or not the email address is confirmed
708 This runs before the other checks, such as anonymity and the real check; return
709 true to allow those checks to occur, and false if checking is done.
711 'EmailUser': before sending email from one user to another
712 $to: address of receiving user
713 $from: address of sending user
714 $subject: subject of the mail
715 $text: text of the mail
717 'EmailUserComplete': after sending email from one user to another
718 $to: address of receiving user
719 $from: address of sending user
720 $subject: subject of the mail
721 $text: text of the mail
723 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
724 $user: The user who is trying to email another user.
725 $editToken: The user's edit token.
726 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
728 'FetchChangesList': When fetching the ChangesList derivative for
730 &$user: User the list is being fetched for
731 &$skin: Skin object to be used with the list
732 &$list: List object (defaults to NULL, change it to an object
733 instance and return false override the list derivative used)
735 'FileDeleteComplete': When a file is deleted
736 $file: reference to the deleted file
737 $oldimage: in case of the deletion of an old image, the name of the old file
738 $article: in case all revisions of the file are deleted a reference to the
739 article associated with the file.
740 $user: user who performed the deletion
743 'FileUpload': When a file upload occurs
744 $file : Image object representing the file that was uploaded
746 'FileUndeleteComplete': When a file is undeleted
747 $title: title object to the file
748 $fileVersions: array of undeleted versions. Empty if all versions were restored
749 $user: user who performed the undeletion
752 'GetAutoPromoteGroups': When determining which autopromote groups a user
753 is entitled to be in.
754 &$user: user to promote.
755 &$promote: groups that will be added.
757 'GetBlockedStatus': after loading blocking status of an user from the database
758 $user: user (object) being checked
760 'GetCacheVaryCookies': get cookies that should vary cache options
761 $out: OutputPage object
762 &$cookies: array of cookies name, add a value to it if you want to add a cookie
763 that have to vary cache options
765 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
766 $title: Title object of page
767 $url: string value as output (out parameter, can modify)
768 $query: query options passed to Title::getFullURL()
770 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
771 $title: Title object of page
772 $url: string value as output (out parameter, can modify)
773 $query: query options passed to Title::getInternalURL()
775 'GetLinkColours': modify the CSS class of an array of page links
776 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
778 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
780 'GetLocalURL': modify local URLs as output into page links
781 $title: Title object of page
782 $url: string value as output (out parameter, can modify)
783 $query: query options passed to Title::getLocalURL()
785 'GetPreferences': modify user preferences
786 $user: User whose preferences are being modified.
787 &$preferences: Preferences description array, to be fed to an HTMLForm object
789 'getUserPermissionsErrors': Add a permissions error when permissions errors are
790 checked for. Use instead of userCan for most cases. Return false if the
791 user can't do it, and populate $result with the reason in the form of
792 array( messagename, param1, param2, ... ). For consistency, error messages
793 should be plain text with no special coloring, bolding, etc. to show that
794 they're errors; presenting them properly to the user as errors is done by
796 $title: Title object being checked against
797 $user : Current user object
798 $action: Action being checked
799 $result: User permissions error to add. If none, return true.
801 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
802 if expensive checks are enabled.
804 'HTMLCacheUpdate::doUpdate': After cache invalidation updates are inserted
806 $title: Title object, pages linked to this title are purged.
808 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
809 image insertion. You can skip the default logic entirely by returning
810 false, or just modify a few things using call-by-reference.
812 &$title: Title object of the image
813 &$file: File object, or false if it doesn't exist
814 &$frameParams: Various parameters with special meanings; see documentation in
815 includes/Linker.php for Linker::makeImageLink2
816 &$handlerParams: Various parameters with special meanings; see documentation in
817 includes/Linker.php for Linker::makeImageLink2
818 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
819 &$res: Final HTML output, used if you return false
822 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
823 the image on an image page
824 $imagePage: ImagePage object ($this)
827 'ImagePageFileHistoryLine': called when a file history line is contructed
829 $line: the HTML of the history line
830 $css: the line CSS class
832 'ImagePageFindFile': called when fetching the file associated with an image page
833 $page: ImagePage object
835 &$displayFile: displayed File object
837 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
838 $title: Title object ($wgTitle)
840 $ignoreRedirect: boolean to skip redirect check
841 $target: Title/string of redirect target
842 $article: Article object
844 'InternalParseBeforeLinks': during Parser's internalParse method before links
845 but after noinclude/includeonly/onlyinclude and other processing.
846 &$this: Parser object
847 &$text: string containing partially parsed text
848 &$this->mStripState: Parser's internal StripState object
850 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
851 $user: user (object) whose email is being invalidated
853 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
854 $article: article (object) being checked
856 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
858 $result: Change this value to override the result of wfIsTrustedProxy()
860 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
861 tance to return false if the domain name doesn't match your organization
862 $addr: The e-mail address entered by the user
863 &$result: Set this and return false to override the internal checks
865 'isValidPassword': Override the result of User::isValidPassword()
866 $password: The password entered by the user
867 &$result: Set this and return false to override the internal checks
868 $user: User the password is being validated for
870 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
871 $wgExtensionMessagesFiles instead.
872 Use this to define synonyms of magic words depending of the language
873 $magicExtensions: associative array of magic words synonyms
874 $lang: laguage code (string)
876 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
877 listed in $wgExtensionMessagesFiles instead.
878 Use to define aliases of special pages names depending of the language
879 $specialPageAliases: associative array of magic words synonyms
880 $lang: laguage code (string)
882 'LinkBegin': Used when generating internal and interwiki links in
883 Linker::link(), before processing starts. Return false to skip default proces-
884 sing and return $ret. See documentation for Linker::link() for details on the
885 expected meanings of parameters.
886 $skin: the Skin object
887 $target: the Title that the link is pointing to
888 &$text: the contents that the <a> tag should have (raw HTML); null means "de-
890 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
891 tive array form, with keys and values unescaped. Should be merged with de-
892 fault values, with a value of false meaning to suppress the attribute.
893 &$query: the query string to add to the generated URL (the bit after the "?"),
894 in associative array form, with keys and values unescaped.
895 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
896 &$ret: the value to return if your hook returns false.
898 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
899 just before the function returns a value. If you return true, an <a> element
900 with HTML attributes $attribs and contents $text will be returned. If you re-
901 turn false, $ret will be returned.
902 $skin: the Skin object
903 $target: the Title object that the link is pointing to
904 $options: the options. Will always include either 'known' or 'broken', and may
906 &$text: the final (raw HTML) contents of the <a> tag, after processing.
907 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
909 &$ret: the value to return if your hook returns false.
911 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
914 &$alt: the image's alt text
915 &$img: the new image HTML (if returning false)
917 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
920 &$text: the link text
921 &$link: the new link HTML (if returning false)
922 &$attribs: the attributes to be applied.
923 $linkType: The external link type
925 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
927 &$linksUpdate: the LinkUpdate object
929 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
931 &$linksUpdate: the LinkUpdate object
933 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
934 &$linksUpdate: the LinkUpdate object
936 'ListDefinedTags': When trying to find all defined tags.
937 &$tags: The list of tags.
939 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading
942 'LocalFile::getHistory': called before file history query performed
945 $fields: select fields
948 $join_conds: JOIN conditions
950 'LocalisationCacheRecache': Called when loading the localisation data into cache
951 $cache: The LocalisationCache object
953 &$alldata: The localisation data from core and extensions
955 'LoginAuthenticateAudit': a login attempt for a valid user account either
956 succeeded or failed. No return data is accepted; this hook is for auditing only.
957 $user: the User object being authenticated against
958 $password: the password being submitted and found wanting
959 $retval: a LoginForm class constant with authenticateUserData() return
960 value (SUCCESS, WRONG_PASS, etc)
962 'LogLine': Processes a single log entry on Special:Log
963 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
964 logging.log_type database field.
965 $log_action: string for the type of log action (e.g. 'delete', 'block',
966 'create2'). Corresponds to logging.log_action database field.
967 $title: Title object that corresponds to logging.log_namespace and
968 logging.log_title database fields.
969 $paramArray: Array of parameters that corresponds to logging.log_params field.
970 Note that only $paramArray[0] appears to contain anything.
971 &$comment: string that corresponds to logging.log_comment database field, and
972 which is displayed in the UI.
973 &$revert: string that is displayed in the UI, similar to $comment.
974 $time: timestamp of the log entry (added in 1.12)
976 'LogPageValidTypes': action being logged.
977 DEPRECATED: Use $wgLogTypes
978 &$type: array of strings
980 'LogPageLogName': name of the logging page(s).
981 DEPRECATED: Use $wgLogNames
982 &$typeText: array of strings
984 'LogPageLogHeader': strings used by wfMsg as a header.
985 DEPRECATED: Use $wgLogHeaders
986 &$headerText: array of strings
988 'LogPageActionText': strings used by wfMsg as a header.
989 DEPRECATED: Use $wgLogActions
990 &$actionText: array of strings
992 'MagicWordMagicWords': When defining new magic word.
993 DEPRECATED: use $magicWords in a file listed in
994 $wgExtensionMessagesFiles instead.
995 $magicWords: array of strings
997 'MagicWordwgVariableIDs': When definig new magic words IDs.
998 $variableIDs: array of strings
1000 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1002 &$vars: variable (or multiple variables) to be added into the output
1003 of Skin::makeVariablesScript
1005 'MarkPatrolled': before an edit is marked patrolled
1006 $rcid: ID of the revision to be marked patrolled
1007 $user: the user (object) marking the revision as patrolled
1008 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1009 needs to be a sysop in order to mark an edit patrolled
1011 'MarkPatrolledComplete': after an edit is marked patrolled
1012 $rcid: ID of the revision marked as patrolled
1013 $user: user (object) who marked the edit patrolled
1014 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1015 must be a sysop to patrol the edit
1017 'MathAfterTexvc': after texvc is executed when rendering mathematics
1018 $mathRenderer: instance of MathRenderer
1019 $errmsg: error message, in HTML (string). Nonempty indicates failure
1020 of rendering the formula
1022 'MediaWikiPerformAction': Override MediaWiki::performAction().
1023 Use this to do something completely different, after the basic
1024 globals have been set up, but before ordinary actions take place.
1026 $article: $wgArticle
1029 $request: $wgRequest
1030 $this: The $mediawiki object
1032 'MessagesPreLoad': When loading a message from the database
1033 $title: title of the message (string)
1034 $message: value (string), change it to the message you want to define
1036 'MessageCacheReplace': When a message page is changed.
1037 Useful for updating caches.
1038 $title: name of the page changed.
1039 $text: new contents of the page.
1041 'ModifyExportQuery': Modify the query used by the exporter.
1042 $db: The database object to be queried.
1043 &$tables: Tables in the query.
1044 &$conds: Conditions in the query.
1045 &$opts: Options for the query.
1046 &$join_conds: Join conditions for the query.
1048 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1049 been rendered (useful for adding more)
1050 Note: this is only run for the Monobook skin. To add items to the toolbox
1051 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
1053 $tools: array of tools
1055 'NewRevisionFromEditComplete': called when a revision was inserted
1057 $article: the article edited
1058 $rev: the new revision
1059 $baseID: the revision ID this was based off, if any
1060 $user: the editing user
1062 'NormalizeMessageKey': Called before the software gets the text of a message
1063 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1065 &$key: the message being looked up. Change this to something else to change
1066 what message gets displayed (string)
1067 &$useDB: whether or not to look up the message in the database (bool)
1068 &$langCode: the language code to get the message for (string) - or -
1069 whether to use the content language (true) or site language (false) (bool)
1070 &$transform: whether or not to expand variables and templates
1071 in the message (bool)
1073 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1074 &$changeslist: The OldChangesList instance.
1075 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1076 &$rc: The RecentChange object.
1078 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1079 Hooks can alter or append to the array of URLs for search & suggestion formats.
1080 &$urls: array of associative arrays with Url element attributes
1082 'OutputPageBeforeHTML': a page has been processed by the parser and
1083 the resulting HTML is about to be displayed.
1084 $parserOutput: the parserOutput (object) that corresponds to the page
1085 $text: the text that will be displayed, in HTML (string)
1087 'OutputPageCheckLastModified': when checking if the page has been modified
1088 since the last visit
1089 &$modifiedTimes: array of timestamps.
1090 The following keys are set: page, user, epoch
1092 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1093 $out: OutputPage instance (object)
1094 $parserOutput: parserOutput instance being added in $out
1096 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1097 categories. Implementations should return false if they generate the category
1098 links, so the default link generation is skipped.
1099 $out: OutputPage instance (object)
1100 $categories: associative array, keys are category names, values are category
1101 types ("normal" or "hidden")
1102 $links: array, intended to hold the result. Must be an associative array with
1103 category types as keys and arrays of HTML links as values.
1105 'PageHistoryBeforeList': When a history page list is about to be constructed.
1106 $article: the article that the history is loading for
1108 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1109 $row: the revision row for this line
1110 $s: the string representing this parsed line
1112 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1115 $queryInfo: the query parameters
1117 'PageRenderingHash': alter the parser cache option hash key
1118 A parser extension which depends on user options should install
1119 this hook and append its values to the key.
1120 $hash: reference to a hash key string which can be modified
1122 'ParserAfterStrip': Same as ParserBeforeStrip
1124 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1125 $parser: Parser object being used
1126 $text: text that'll be returned
1128 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1129 $parser: Parser object
1130 $text: text to parse
1131 $stripState: StripState instance being used
1133 'ParserBeforeStrip': Called at start of parsing time
1134 (no more strip, deprecated ?)
1135 $parser: parser object
1136 $text: text being parsed
1137 $stripState: stripState used (object)
1139 'ParserBeforeTidy': called before tidy and custom tags replacements
1140 $parser: Parser object being used
1143 'ParserClearState': called at the end of Parser::clearState()
1144 $parser: Parser object being cleared
1146 'ParserFirstCallInit': called when the parser initialises for the first time
1147 &$parser: Parser object being cleared
1149 'ParserGetVariableValueSwitch': called when the parser need the value of a
1151 $parser: Parser object
1152 $varCache: array to store the value in case of multiples calls of the
1154 $index: index (string) of the magic
1155 $ret: value of the magic word (the hook should set it)
1156 $frame: PPFrame object to use for expanding any template variables
1158 'ParserGetVariableValueTs': use this to change the value of the time for the
1159 {{LOCAL...}} magic word
1160 $parser: Parser object
1161 $time: actual time (timestamp)
1163 'ParserGetVariableValueVarCache': use this to change the value of the
1164 variable cache or return false to not use it
1165 $parser: Parser object
1166 $varCache: varaiable cache (array)
1168 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1169 include comments about size of the text parsed
1170 $parser: Parser object
1171 $limitReport: text that will be included (without comment tags)
1173 'ParserMakeImageParams': Called before the parser make an image link, use this
1174 to modify the parameters of the image.
1175 $title: title object representing the file
1176 $file: file object that will be used to create the image
1177 &$params: 2-D array of parameters
1179 'ParserTestParser': called when creating a new instance of Parser in
1180 maintenance/parserTests.inc
1181 $parser: Parser object created
1183 'ParserTestTables': alter the list of tables to duplicate when parser tests
1184 are run. Use when page save hooks require the presence of custom tables
1185 to ensure that tests continue to run properly.
1186 &$tables: array of table names
1188 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1189 my talk page, my contributions" etc).
1191 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1192 &$title: Title object representing the current page
1194 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1195 &$user : User performing the action
1196 $action : Action being performed
1197 &$result : Whether or not the action should be prevented
1198 Change $result and return false to give a definitive answer, otherwise
1199 the built-in rate limiting checks are used, if enabled.
1201 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1202 AJAX search suggestions. Put results into &$results outparam and return false.
1203 $ns : array of int namespace keys to search in
1204 $search : search term (not guaranteed to be conveniently normalized)
1205 $limit : maximum number of results to return
1206 &$results : out param: array of page names (strings)
1208 'PrefsEmailAudit': called when user changes his email address
1209 $user: User (object) changing his email address
1210 $oldaddr: old email address (string)
1211 $newaddr: new email address (string)
1213 'PrefsPasswordAudit': called when user changes his password
1214 $user: User (object) changing his passoword
1215 $newPass: new password
1216 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1218 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1219 $article: the title being (un)protected
1220 $output: a string of the form HTML so far
1222 'ProtectionForm::save': called when a protection form is submitted
1223 $article: the title being (un)protected
1224 $errorMsg: an html message string of an error
1226 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1227 $article: the page the form is shown for
1228 $out: OutputPage object
1230 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1231 &$obj: RawPage object
1232 &$text: The text that's going to be the output
1234 'RecentChange_save': called at the end of RecenChange::save()
1235 $recentChange: RecentChange object
1237 'RevisionInsertComplete': called after a revision is inserted into the DB
1238 &$revision: the Revision
1239 $data: the data stored in old_text. The meaning depends on $flags: if external
1240 is set, it's the URL of the revision text in external storage; otherwise,
1241 it's the revision text itself. In either case, if gzip is set, the revision
1243 $flags: a comma-delimited list of strings representing the options used. May
1244 include: utf8 (this will always be set for new revisions); gzip; external.
1246 'SearchUpdate': Prior to search update completion
1248 $namespace : Page namespace
1250 $text : Current text being indexed
1252 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
1253 $term : Search term string
1254 &$title : Outparam; set to $title object and return false for a match
1256 'SetupAfterCache': Called in Setup.php, after cache objects are set
1258 'ShowMissingArticle': Called when generating the output for a non-existent page
1259 $article: The article object corresponding to the page
1261 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1262 $text: Text being shown
1263 $title: Title of the custom script/stylesheet page
1264 $output: Current OutputPage object
1266 'ShowSearchHitTitle': Customise display of search hit title/link.
1267 &$title: Title to link to
1268 &$text: Text to use for the link
1269 $result: The search result
1270 $terms: The search terms entered
1271 $page: The SpecialSearch object.
1273 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1274 &$siteNotice: HTML returned as the sitenotice
1275 Return true to allow the normal method of notice selection/rendering to work,
1276 or change the value of $siteNotice and return false to alter it.
1278 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1279 &$siteNotice: HTML sitenotice
1280 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1282 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1284 &$text: bottomScripts Text
1285 Append to $text to add additional text/scripts after the stock bottom scripts.
1287 'SkinAfterContent': Allows extensions to add text after the page content and
1289 &$data: (string) Text to be printed out directly (without parsing)
1290 This hook should work in all skins. Just set the &$data variable to the text
1291 you're going to add.
1293 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1295 &$bar: Sidebar contents
1296 Modify $bar to add or modify sidebar portlets.
1298 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1299 $title: displayed page title
1300 $type: 'normal' or 'history' for old/diff views
1301 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1302 &$link: overridable HTML link to be passed into the message as $1
1304 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1306 &$subpages: Subpage links HTML
1307 If false is returned $subpages will be used instead of the HTML
1308 subPageSubtitle() generates.
1309 If true is returned, $subpages will be ignored and the rest of
1310 subPageSubtitle() will run.
1312 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab
1313 when showing a special page
1314 $sktemplate: SkinTemplate object
1315 $content_actions: array of tabs
1317 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1318 "permanent link" tab
1319 $sktemplate: SkinTemplate object
1320 $nav_urls: array of tabs
1322 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1323 &$content_actions: Content actions
1324 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1327 'SkinTemplateNavigation': Alter the structured navigation links in SkinTemplates
1328 &$sktemplate: SkinTemplate object
1329 &$links: Structured navigation links
1330 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1332 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1334 &$sktemplate: SkinTemplate object
1335 &$tpl: Template engine object
1337 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1338 $sktemplate: SkinTemplate object
1339 $res: set to true to prevent active tabs
1341 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1344 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1345 You can either create your own array, or alter the parameters for
1347 &$this: The SkinTemplate instance.
1348 $title: Title instance for the page.
1349 $message: Visible label of tab.
1350 $selected: Whether this is a selected tab.
1351 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1352 &$classes: Array of CSS classes to apply.
1353 &$query: Query string to add to link.
1355 &$result: Complete assoc. array if you want to return true.
1357 'SkinTemplateTabs': called when finished to build the actions tabs
1358 $sktemplate: SkinTemplate object
1359 $content_actions: array of tabs
1361 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1362 been rendered (useful for adding more)
1363 $tools: array of tools
1365 'SoftwareInfo': Called by Special:Version for returning information about
1367 $software: The array of software in format 'name' => 'version'.
1368 See SpecialVersion::softwareInformation()
1370 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1371 $id: User identifier
1373 'SpecialListusersDefaultQuery': called right before the end of
1374 UsersPager::getDefaultQuery()
1375 $pager: The UsersPager instance
1376 $query: The query array to be returned
1378 'SpecialListusersFormatRow': called right before the end of
1379 UsersPager::formatRow()
1380 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1381 $row: Database row object
1383 'SpecialListusersHeader': called before closing the <fieldset> in
1384 UsersPager::getPageHeader()
1385 $pager: The UsersPager instance
1386 $out: The header HTML
1388 'SpecialListusersHeaderForm': called before adding the submit button in
1389 UsersPager::getPageHeader()
1390 $pager: The UsersPager instance
1391 $out: The header HTML
1393 'SpecialListusersQueryInfo': called right before the end of
1394 UsersPager::getQueryInfo()
1395 $pager: The UsersPager instance
1396 $query: The query array to be returned
1398 'SpecialMovepageAfterMove': called after moving a page
1399 $movePage: MovePageForm object
1400 $oldTitle: old title (object)
1401 $newTitle: new title (object)
1403 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1404 hook to remove a core special page
1405 $list: list (array) of core special pages
1407 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1408 use this to change some selection criteria or substitute a different title
1409 &$randstr: The random number from wfRandom()
1410 &$isRedir: Boolean, whether to select a redirect or non-redirect
1411 &$namespaces: An array of namespace indexes to get the title from
1412 &$extra: An array of extra SQL statements
1413 &$title: If the hook returns false, a Title object to use instead of the
1414 result from the normal query
1416 'SpecialRecentChangesPanel': called when building form options in
1417 SpecialRecentChanges
1418 &$extraOpts: array of added items, to which can be added
1419 $opts: FormOptions for this request
1421 'SpecialRecentChangesQuery': called when building sql query for
1422 SpecialRecentChanges
1423 &$conds: array of WHERE conditionals for query
1424 &$tables: array of tables to be queried
1425 &$join_conds: join conditions for the tables
1426 $opts: FormOptions for this request
1428 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1429 target doesn't exist
1430 $title: title object generated from the text entred by the user
1432 'SpecialSearchProfiles': allows modification of search profiles
1433 &$profiles: profiles, which can be modified.
1435 'SpecialSearchResults': called before search result display when there
1437 $term: string of search term
1438 &$titleMatches: empty or SearchResultSet object
1439 &$textMatches: empty or SearchResultSet object
1441 'SpecialSearchNoResults': called before search result display when there are
1443 $term: string of search term
1445 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1446 &$extraStats: Array to save the new stats
1447 ( $extraStats['<name of statistic>'] => <value>; )
1449 'SpecialUploadComplete': Called after successfully uploading a file from
1451 $form: The SpecialUpload object
1453 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1454 use this to change the tables headers
1455 $extTypes: associative array of extensions types
1457 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1458 &$conds: array of WHERE conditionals for query
1459 &$tables: array of tables to be queried
1460 &$join_conds: join conditions for the tables
1461 &$fields: array of query fields
1463 'TitleArrayFromResult': called when creating an TitleArray object from a
1465 &$titleArray: set this to an object to override the default object returned
1466 $res: database result used to create the object
1468 'TitleMoveComplete': after moving an article (title)
1471 $user: user who did the move
1472 $pageid: database ID of the page that's been moved
1473 $redirid: database ID of the created redirect
1475 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1476 $title: title object related to the revision
1477 $rev: revision (object) that will be viewed
1479 'UnknownAction': An unknown "action" has occured (useful for defining
1481 $action: action name
1482 $article: article "acted on"
1484 'UnwatchArticle': before a watch is removed from an article
1485 $user: user watching
1486 $article: article object to be removed
1488 'UnwatchArticle': after a watch is removed from an article
1489 $user: user that was watching
1490 $article: article object removed
1492 'UnwatchArticleComplete': after a watch is removed from an article
1493 $user: user that watched
1494 $article: article object that was watched
1496 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1497 string $type: the requested upload type
1498 &$className: the class name of the Upload instance to be created
1500 'UploadComplete': when Upload completes an upload
1501 &$upload: an UploadBase child instance
1503 'UploadFormInitDescriptor': after the descriptor for the upload form as been
1505 array $descriptor: the HTMLForm descriptor
1507 'UploadFormSourceDescriptors': after the standard source inputs have been
1508 added to the descriptor
1509 array $descriptor: the HTMLForm descriptor
1511 'UploadVerification': additional chances to reject an uploaded file
1512 string $saveName: destination file name
1513 string $tempName: filesystem path to the temporary file for checks
1514 string &$error: output: HTML error to show if upload canceled by returning false
1516 'UploadComplete': Upon completion of a file upload
1517 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1518 $uploadBase->getLocalFile().
1520 'User::mailPasswordInternal': before creation and mailing of a user's new
1522 $user: the user who sent the message out
1523 $ip: IP of the user who sent the message out
1524 $u: the account whose new password will be set
1526 'UserArrayFromResult': called when creating an UserArray object from a
1528 &$userArray: set this to an object to override the default object returned
1529 $res: database result used to create the object
1531 'userCan': To interrupt/advise the "user can do X to Y article" check.
1532 If you want to display an error message, try getUserPermissionsErrors.
1533 $title: Title object being checked against
1534 $user : Current user object
1535 $action: Action being checked
1536 $result: Pointer to result returned if hook returns false. If null is returned,
1537 userCan checks are continued by internal code.
1539 'UserCanSendEmail': To override User::canSendEmail() permission check
1540 $user: User (object) whose permission is being checked
1541 &$canSend: bool set on input, can override on output
1543 'UserClearNewTalkNotification': called when clearing the
1544 "You have new messages!" message, return false to not delete it
1545 $user: User (object) that'll clear the message
1547 'UserComparePasswords': called when checking passwords, return false to
1548 override the default password checks
1549 &$hash: String of the password hash (from the database)
1550 &$password: String of the plaintext password the user entered
1551 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1553 &$result: If the hook returns false, this Boolean value will be checked to
1554 determine if the password was valid
1556 'UserCreateForm': change to manipulate the login form
1557 $template: SimpleTemplate instance for the form
1559 'UserCryptPassword': called when hashing a password, return false to implement
1560 your own hashing method
1561 &$password: String of the plaintext password to encrypt
1562 &$salt: String of the password salt or Boolean false if no salt is provided
1563 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1565 &$hash: If the hook returns false, this String will be used as the hash
1567 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1568 $user: User to get groups for
1569 &$groups: Current effective groups
1571 'UserGetAllRights': after calculating a list of all available rights
1572 &$rights: Array of rights, which may be added to.
1574 'UserGetEmail': called when getting an user email address
1576 &$email: email, change this to override local email
1578 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1579 email authentification
1581 &$timestamp: timestamp, change this to override local email authentification
1584 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1585 &$groups: List of implicit (automatically-assigned) groups
1587 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1588 &$reservedUsernames: $wgReservedUsernames
1590 'UserGetRights': Called in User::getRights()
1591 $user: User to get rights for
1592 &$rights: Current rights
1594 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
1596 $user: User in question
1597 $title: Title of the page in question
1598 &$blocked: Out-param, whether or not the user is blocked from that page.
1599 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
1600 own user talk pages.
1602 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
1604 $ip: User's IP address
1605 &$blocked: Whether the user is blocked, to be modified by the hook
1607 'UserLoadAfterLoadFromSession': called to authenticate users on
1608 external/environmental means; occurs after session is loaded
1609 $user: user object being loaded
1611 'UserLoadDefaults': called when loading a default user
1615 'UserLoadFromDatabase': called when loading a user from the database
1617 &$s: database query object
1619 'UserLoadFromSession': called to authenticate users on external/environmental
1620 means; occurs before session is loaded
1621 $user: user object being loaded
1622 &$result: set this to a boolean value to abort the normal authentification
1625 'UserLoadOptions': when user options/preferences are being loaded from
1628 &$options: Options, can be modified.
1630 'UserLoginComplete': after a user has logged in
1631 $user: the user object that was created on login
1632 $inject_html: Any HTML to inject after the "logged in" message.
1634 'UserLoginForm': change to manipulate the login form
1635 $template: SimpleTemplate instance for the form
1637 'UserLoginMailPassword': Block users from emailing passwords
1638 $name: the username to email the password of.
1639 &$error: out-param - the error message to return.
1641 'UserLogout': before a user logs out
1642 $user: the user object that is about to be logged out
1644 'UserLogoutComplete': after a user has logged out
1645 $user: the user object _after_ logout (won't have name, ID, etc.)
1646 $inject_html: Any HTML to inject after the "logged out" message.
1647 $oldName: name of the user before logout (string)
1649 'UserRights': After a user's group memberships are changed
1650 $user : User object that was changed
1651 $add : Array of strings corresponding to groups added
1652 $remove: Array of strings corresponding to groups removed
1654 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
1656 $user: user retrieving new talks messages
1657 $talks: array of new talks page(s)
1659 'UserSaveSettings': called when saving user settings
1662 'UserSaveOptions': Called just before saving user preferences/options.
1664 &$options: Options, modifiable
1666 'UserSetCookies': called when setting user cookies
1668 &$session: session array, will be added to $_SESSION
1669 &$cookies: cookies array mapping cookie name to its value
1671 'UserSetEmail': called when changing user email address
1673 &$email: new email, change this to override new email address
1675 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
1676 of email authentification
1678 &$timestamp: new timestamp, change this to override local email
1679 authentification timestamp
1681 'UserToggles': called when initialising User::$mToggles, use this to add
1683 $toggles: array of toggles to add
1685 'VectorTemplateToolboxEnd': Called by Vector skin after toolbox links have
1686 been rendered (useful for adding more)
1687 Note: this is only run for the Vector skin. To add items to the toolbox
1688 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
1690 $tools: array of tools
1692 'WantedPages::getSQL': called in WantedPagesPage::getSQL(), can be used to
1693 alter the SQL query which gets the list of wanted pages
1694 &$wantedPages: WantedPagesPage object
1695 &$sql: raw SQL query used to get the list of wanted pages
1697 'WatchArticle': before a watch is added to an article
1698 $user: user that will watch
1699 $article: article object to be watched
1701 'WatchArticleComplete': after a watch is added to an article
1702 $user: user that watched
1703 $article: article object watched
1705 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
1707 One, and only one hook should set this, and return false.
1708 &$tables: Database tables to use in the SELECT query
1709 &$opts: Options to use for the query
1710 &$join: Join conditions
1712 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
1713 query pages to be updated with maintenance/updateSpecialPages.php
1714 $query: $wgQueryPages itself
1716 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
1717 metadata to be added.
1718 $obj: The XmlDumpWriter object.
1719 &$out: The output string.
1720 $row: The database row for the page.
1721 $title: The title of the page.
1723 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
1725 $obj: The XmlDumpWriter object.
1726 &$out: The text being output.
1727 $row: The database row for the revision.
1728 $text: The revision text.
1730 More hooks might be available but undocumented, you can execute
1731 ./maintenance/findhooks.php to find hidden one.