3 This document describes how event hooks work in MediaWiki; how to add hooks for
4 an event; and how to run hooks for an event.
9 Something that happens with the wiki. For example: a user logs in. A wiki
10 page is saved. A wiki page is deleted. Often there are two events
11 associated with a single action: one before the code is run to make the
12 event happen, and one after. Each event has a name, preferably in
13 CamelCase. For example, 'UserLogin', 'ArticleSave', 'ArticleSaveComplete',
17 A clump of code and data that should be run when an event happens. This can
18 be either a function and a chunk of data, or an object and a method.
21 The function part of a hook.
25 Hooks allow us to decouple optionally-run code from code that is run for
26 everyone. It allows MediaWiki hackers, third-party developers and local
27 administrators to define code that will be run at certain points in the mainline
28 code, and to modify the data run by that mainline code. Hooks can keep mainline
29 code simple, and make it easier to write extensions. Hooks are a principled
30 alternative to local patches.
32 Consider, for example, two options in MediaWiki. One reverses the order of a
33 title before displaying the article; the other converts the title to all
34 uppercase letters. Currently, in MediaWiki code, we would handle this as follows
35 (note: not real code, here):
37 function showAnArticle($article) {
38 global $wgReverseTitle, $wgCapitalizeTitle;
40 if ($wgReverseTitle) {
41 wfReverseTitle($article);
44 if ($wgCapitalizeTitle) {
45 wfCapitalizeTitle($article);
48 # code to actually show the article goes here
51 An extension writer, or a local admin, will often add custom code to the
52 function -- with or without a global variable. For example, someone wanting
53 email notification when an article is shown may add:
55 function showAnArticle($article) {
56 global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
58 if ($wgReverseTitle) {
59 wfReverseTitle($article);
62 if ($wgCapitalizeTitle) {
63 wfCapitalizeTitle($article);
66 # code to actually show the article goes here
68 if ($wgNotifyArticle) {
69 wfNotifyArticleShow($article));
73 Using a hook-running strategy, we can avoid having all this option-specific
74 stuff in our mainline code. Using hooks, the function becomes:
76 function showAnArticle($article) {
78 if (wfRunHooks('ArticleShow', array(&$article))) {
80 # code to actually show the article goes here
82 wfRunHooks('ArticleShowComplete', array(&$article));
86 We've cleaned up the code here by removing clumps of weird, infrequently used
87 code and moving them off somewhere else. It's much easier for someone working
88 with this code to see what's _really_ going on, and make changes or fix bugs.
90 In addition, we can take all the code that deals with the little-used
91 title-reversing options (say) and put it in one place. Instead of having little
92 title-reversing if-blocks spread all over the codebase in showAnArticle,
93 deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
96 function reverseArticleTitle($article) {
100 function reverseForExport($article) {
104 The setup function for the extension just has to add its hook functions to the
107 setupTitleReversingExtension() {
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
115 Having all this code related to the title-reversion option in one place means
116 that it's easier to read and understand; you don't have to do a grep-find to see
117 where the $wgReverseTitle variable is used, say.
119 If the code is well enough isolated, it can even be excluded when not used --
120 making for some slight savings in memory and load-up performance at runtime.
121 Admins who want to have all the reversed titles can add:
123 require_once('extensions/ReverseTitle.php');
125 ...to their LocalSettings.php file; those of us who don't want or need it can
128 The extensions don't even have to be shipped with MediaWiki; they could be
129 provided by a third-party developer or written by the admin him/herself.
133 A hook is a chunk of code run at some particular event. It consists of:
135 * a function with some optional accompanying data, or
136 * an object with a method and some optional accompanying data.
138 Hooks are registered by adding them to the global $wgHooks array for a given
139 event. All the following are valid ways to define hooks:
141 $wgHooks['EventName'][] = 'someFunction'; # function, no data
142 $wgHooks['EventName'][] = array('someFunction', $someData);
143 $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
145 $wgHooks['EventName'][] = $object; # object only
146 $wgHooks['EventName'][] = array($object, 'someMethod');
147 $wgHooks['EventName'][] = array($object, 'someMethod', $someData);
148 $wgHooks['EventName'][] = array($object); # weird but OK
150 When an event occurs, the function (or object method) will be called with the
151 optional data provided as well as event-specific parameters. The above examples
152 would result in the following code being executed when 'EventName' happened:
155 someFunction($param1, $param2)
157 someFunction($someData, $param1, $param2)
160 $object->onEventName($param1, $param2)
162 $object->someMethod($param1, $param2)
163 # object with method and data
164 $object->someMethod($someData, $param1, $param2)
166 Note that when an object is the hook, and there's no specified method, the
167 default method called is 'onEventName'. For different events this would be
168 different: 'onArticleSave', 'onUserLogin', etc.
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
173 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
174 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
179 Hooks can return three possible values:
181 * true: the hook has operated successfully
182 * "some string": an error occurred; processing should stop and the error
183 should be shown to the user
184 * false: the hook has successfully done the work necessary and the calling
187 The last result would be for cases where the hook function replaces the main
188 functionality. For example, if you wanted to authenticate users to a custom
189 system (LDAP, another PHP program, whatever), you could do:
191 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
193 function ldapLogin($username, $password) {
198 Returning false makes less sense for events where the action is complete, and
199 will normally be ignored.
201 Note that none of the examples made use of create_function() as a way to
202 attach a function to a hook. This is known to cause problems (notably with
203 Special:Version), and should be avoided when at all possible.
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
214 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
215 # protect the article
216 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
221 wfRunHooks() returns true if the calling function should continue processing
222 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
223 error occurred, or one of the hooks handled the action already). Checking the
224 return value matters more for "before" hooks than for "complete" hooks.
226 Note that hook parameters are passed in an array; this is a necessary
227 inconvenience to make it possible to pass reference values (that can be changed)
228 into the hook code. Also note that earlier versions of wfRunHooks took a
229 variable number of arguments; the array() calling protocol came about after
232 ==Events and parameters==
234 This is a list of known events and parameters; please add to it if you're going
235 to add events to the MediaWiki code.
237 'AbortAutoblock': Return false to cancel an autoblock.
238 $autoblockip: The IP going to be autoblocked.
239 $block: The block from which the autoblock is coming.
241 'AbortDiffCache': Can be used to cancel the caching of a diff
242 &$diffEngine: DifferenceEngine object
244 'AbortLogin': Return false to cancel account login.
245 $user: the User object being authenticated against
246 $password: the password being submitted, not yet checked for validity
247 &$retval: a LoginForm class constant to return from authenticateUserData();
248 default is LoginForm::ABORTED. Note that the client may be using
249 a machine API rather than the HTML user interface.
251 'AbortMove': allows to abort moving an article (title)
254 $user: user who is doing the move
256 $reason: the reason for the move (added in 1.13)
258 'AbortNewAccount': Return false to cancel account creation.
259 $user: the User object about to be created (read-only, incomplete)
260 $message: out parameter: error message to display on abort
262 'AddNewAccount': after a user account is created
263 $user: the User object that was created. (Parameter added in 1.7)
264 $byEmail: true when account was created "by email" (added in 1.12)
266 'AjaxAddScript': Called in output page just before the initialisation
267 of the javascript ajax engine. The hook is only called when ajax
268 is enabled ( $wgUseAjax = true; ).
270 'AlternateEdit': before checking if an user can edit a page and
271 before showing the edit form ( EditPage::edit() ). This is triggered
273 $EditPage: the EditPage object
275 'APIAfterExecute': after calling the execute() method of an API module.
276 Use this to extend core API modules.
277 &$module: Module object
279 'APIEditBeforeSave': before saving a page with api.php?action=edit,
280 after processing request parameters. Return false to let the request
281 fail, returning an error message or an <edit result="Failure"> tag
282 if $resultArr was filled.
283 $EditPage : the EditPage object
284 $text : the new text of the article (has yet to be saved)
285 &$resultArr : data in this array will be added to the API result
287 'APIGetAllowedParams': use this hook to modify a module's parameters.
288 &$module: Module object
289 &$params: Array of parameters
291 'APIGetParamDescription': use this hook to modify a module's parameter
293 &$module: Module object
294 &$desc: Array of parameter descriptions
296 'APIQueryAfterExecute': after calling the execute() method of an
297 action=query submodule. Use this to extend core API modules.
298 &$module: Module object
300 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
301 method of an action=query submodule. Use this to extend core API modules.
302 &$module: Module object
303 &$resultPageSet: ApiPageSet object
305 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
306 Every token has an action, which will be used in the intoken parameter
307 and in the output (actiontoken="..."), and a callback function which
308 should return the token, or false if the user isn't allowed to obtain
309 it. The prototype of the callback function is func($pageid, $title)
310 where $pageid is the page ID of the page the token is requested for
311 and $title is the associated Title object. In the hook, just add
312 your callback to the $tokenFunctions array and return true (returning
313 false makes no sense)
314 $tokenFunctions: array(action => callback)
316 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
317 Every token has an action, which will be used in the rvtoken parameter
318 and in the output (actiontoken="..."), and a callback function which
319 should return the token, or false if the user isn't allowed to obtain
320 it. The prototype of the callback function is func($pageid, $title, $rev)
321 where $pageid is the page ID of the page associated to the revision the
322 token is requested for, $title the associated Title object and $rev the
323 associated Revision object. In the hook, just add your callback to the
324 $tokenFunctions array and return true (returning false makes no sense)
325 $tokenFunctions: array(action => callback)
327 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
329 Every token has an action, which will be used in the rctoken parameter
330 and in the output (actiontoken="..."), and a callback function which
331 should return the token, or false if the user isn't allowed to obtain
332 it. The prototype of the callback function is func($pageid, $title, $rc)
333 where $pageid is the page ID of the page associated to the revision the
334 token is requested for, $title the associated Title object and $rc the
335 associated RecentChange object. In the hook, just add your callback to the
336 $tokenFunctions array and return true (returning false makes no sense)
337 $tokenFunctions: array(action => callback)
339 'APIQueryUsersTokens': use this hook to add custom token to list=users.
340 Every token has an action, which will be used in the ustoken parameter
341 and in the output (actiontoken="..."), and a callback function which
342 should return the token, or false if the user isn't allowed to obtain
343 it. The prototype of the callback function is func($user) where $user
344 is the User object. In the hook, just add your callback to the
345 $tokenFunctions array and return true (returning false makes no sense)
346 $tokenFunctions: array(action => callback)
348 'ArticleAfterFetchContent': after fetching content of an article from
350 $article: the article (object) being loaded from the database
351 $content: the content (string) of the article
353 'ArticleConfirmDelete': before writing the confirmation form for article
355 $article: the article (object) being deleted
356 $output: the OutputPage object ($wgOut)
357 &$reason: the reason (string) the article is being deleted
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 $mediaWiki: 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 &$changesList: 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 'EditFormInitialText': Allows modifying the edit form when editing existing
643 $editPage: EditPage object
645 'EditPage::attemptSave': called before an article is
646 saved, that is before insertNewArticle() is called
647 $editpage_Obj: the current EditPage object
649 'EditPage::importFormData': allow extensions to read additional data
651 $editpage: EditPage instance
653 return value is ignored (should always return true)
655 'EditPage::showEditForm:fields': allows injection of form field into edit form
656 &$editor: the EditPage instance for reference
657 &$out: an OutputPage instance to write to
658 return value is ignored (should always return true)
660 'EditPage::showEditForm:initial': before showing the edit form
661 $editor: EditPage instance (object)
663 Return false to halt editing; you'll need to handle error messages, etc.
664 yourself. Alternatively, modifying $error and returning true will cause the
665 contents of $error to be echoed at the top of the edit form as wikitext.
666 Return true without altering $error to allow the edit to proceed.
668 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
669 when there's an edit conflict. Return false to halt normal diff output; in
670 this case you're responsible for computing and outputting the entire "conflict"
671 part, i.e., the "difference between revisions" and "your text" headers and
673 &$editor: EditPage instance
674 &$out: OutputPage instance
676 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
677 textarea in the edit form
678 &$editpage: The current EditPage object
679 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
680 &$tabindex: HTML tabindex of the last edit check/button
682 'EditPageBeforeEditChecks': allows modifying the edit checks below the
683 textarea in the edit form
684 &$editpage: The current EditPage object
685 &$checks: Array of edit checks like "watch this page"/"minor edit"
686 &$tabindex: HTML tabindex of the last edit check/button
688 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
689 textarea in the edit form
690 &$toolbar: The toolbar HTMl
692 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
693 $title: title of page being edited
694 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
696 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
698 $editPage: EditPage object
699 &$newtext: wikitext that will be used as "your version"
701 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed
702 $editPage: EditPage object
703 &$toparse: wikitext that will be parsed
705 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
706 &$editpage: The current EditPage object
707 &$res: the HTML of the error text
709 'EditPageTosSummary': Give a chance for site and per-namespace customizations
710 of terms of service summary link that might exist separately from the copyright
712 $title: title of page being edited
713 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
715 'EditSectionLink': Do not use, use DoEditSectionLink instead.
716 $skin: Skin rendering the UI
717 $title: Title being linked to
718 $section: Section to link to
720 $result: Result (alter this to override the generated links)
722 'EmailConfirmed': When checking that the user's email address is "confirmed"
723 $user: User being checked
724 $confirmed: Whether or not the email address is confirmed
725 This runs before the other checks, such as anonymity and the real check; return
726 true to allow those checks to occur, and false if checking is done.
728 'EmailUser': before sending email from one user to another
729 $to: address of receiving user
730 $from: address of sending user
731 $subject: subject of the mail
732 $text: text of the mail
734 'EmailUserCC': before sending the copy of the email to the author
735 $to: address of receiving user
736 $from: address of sending user
737 $subject: subject of the mail
738 $text: text of the mail
740 'EmailUserComplete': after sending email from one user to another
741 $to: address of receiving user
742 $from: address of sending user
743 $subject: subject of the mail
744 $text: text of the mail
746 'EmailUserForm': after building the email user form object
747 $form: HTMLForm object
749 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
750 $user: The user who is trying to email another user.
751 $editToken: The user's edit token.
752 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
754 'FetchChangesList': When fetching the ChangesList derivative for
756 &$user: User the list is being fetched for
757 &$skin: Skin object to be used with the list
758 &$list: List object (defaults to NULL, change it to an object
759 instance and return false override the list derivative used)
761 'FileDeleteComplete': When a file is deleted
762 $file: reference to the deleted file
763 $oldimage: in case of the deletion of an old image, the name of the old file
764 $article: in case all revisions of the file are deleted a reference to the
765 article associated with the file.
766 $user: user who performed the deletion
769 'FileUpload': When a file upload occurs
770 $file : Image object representing the file that was uploaded
772 'FileUndeleteComplete': When a file is undeleted
773 $title: title object to the file
774 $fileVersions: array of undeleted versions. Empty if all versions were restored
775 $user: user who performed the undeletion
778 'GetAutoPromoteGroups': When determining which autopromote groups a user
779 is entitled to be in.
780 &$user: user to promote.
781 &$promote: groups that will be added.
783 'GetBlockedStatus': after loading blocking status of an user from the database
784 $user: user (object) being checked
786 'GetCacheVaryCookies': get cookies that should vary cache options
787 $out: OutputPage object
788 &$cookies: array of cookies name, add a value to it if you want to add a cookie
789 that have to vary cache options
791 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
792 $title: Title object of page
793 $url: string value as output (out parameter, can modify)
794 $query: query options passed to Title::getFullURL()
796 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
797 $title: Title object of page
798 $url: string value as output (out parameter, can modify)
799 $query: query options passed to Title::getInternalURL()
801 'GetLinkColours': modify the CSS class of an array of page links
802 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
804 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
806 'GetLocalURL': modify local URLs as output into page links
807 $title: Title object of page
808 $url: string value as output (out parameter, can modify)
809 $query: query options passed to Title::getLocalURL()
811 'GetPreferences': modify user preferences
812 $user: User whose preferences are being modified.
813 &$preferences: Preferences description array, to be fed to an HTMLForm object
815 'getUserPermissionsErrors': Add a permissions error when permissions errors are
816 checked for. Use instead of userCan for most cases. Return false if the
817 user can't do it, and populate $result with the reason in the form of
818 array( messagename, param1, param2, ... ). For consistency, error messages
819 should be plain text with no special coloring, bolding, etc. to show that
820 they're errors; presenting them properly to the user as errors is done by
822 $title: Title object being checked against
823 $user : Current user object
824 $action: Action being checked
825 $result: User permissions error to add. If none, return true.
827 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
828 if expensive checks are enabled.
830 'HTMLCacheUpdate::doUpdate': After cache invalidation updates are inserted
832 $title: Title object, pages linked to this title are purged.
834 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
835 image insertion. You can skip the default logic entirely by returning
836 false, or just modify a few things using call-by-reference.
838 &$title: Title object of the image
839 &$file: File object, or false if it doesn't exist
840 &$frameParams: Various parameters with special meanings; see documentation in
841 includes/Linker.php for Linker::makeImageLink2
842 &$handlerParams: Various parameters with special meanings; see documentation in
843 includes/Linker.php for Linker::makeImageLink2
844 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
845 &$res: Final HTML output, used if you return false
848 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
849 the image on an image page
850 $imagePage: ImagePage object ($this)
853 'ImagePageAfterImageLinks': called after the image links section on an image
855 $imagePage: ImagePage object ($this)
856 &$html: HTML for the hook to add
858 'ImagePageFileHistoryLine': called when a file history line is contructed
860 $line: the HTML of the history line
861 $css: the line CSS class
863 'ImagePageFindFile': called when fetching the file associated with an image page
864 $page: ImagePage object
866 &$displayFile: displayed File object
868 'ImagePageShowTOC': called when the file toc on an image page is generated
869 $page: ImagePage object
870 &$toc: Array of <li> strings
872 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
874 &$title: the Title object of the file as it would appear for the upload page
875 &$path: the original file and path name when img_auth was invoked by the the web
877 &$name: the name only component of the file
878 &$result: The location to pass back results of the hook routine (only used if
880 $result[0]=The index of the header message
881 $result[1]=The index of the body text message
882 $result[2 through n]=Parameters passed to body text message. Please note the
883 header message cannot receive/use parameters.
886 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
887 $title: Title object ($wgTitle)
889 $ignoreRedirect: boolean to skip redirect check
890 $target: Title/string of redirect target
891 $article: Article object
893 'InternalParseBeforeLinks': during Parser's internalParse method before links
894 but after noinclude/includeonly/onlyinclude and other processing.
895 &$parser: Parser object
896 &$text: string containing partially parsed text
897 &$stripState: Parser's internal StripState object
899 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
900 $user: user (object) whose email is being invalidated
902 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
903 $article: article (object) being checked
905 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
907 $result: Change this value to override the result of wfIsTrustedProxy()
909 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
910 tance to return false if the domain name doesn't match your organization
911 $addr: The e-mail address entered by the user
912 &$result: Set this and return false to override the internal checks
914 'isValidPassword': Override the result of User::isValidPassword()
915 $password: The password entered by the user
916 &$result: Set this and return false to override the internal checks
917 $user: User the password is being validated for
919 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
920 $wgExtensionMessagesFiles instead.
921 Use this to define synonyms of magic words depending of the language
922 $magicExtensions: associative array of magic words synonyms
923 $lang: laguage code (string)
925 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
926 listed in $wgExtensionMessagesFiles instead.
927 Use to define aliases of special pages names depending of the language
928 $specialPageAliases: associative array of magic words synonyms
929 $lang: laguage code (string)
931 'LinkBegin': Used when generating internal and interwiki links in
932 Linker::link(), before processing starts. Return false to skip default proces-
933 sing and return $ret. See documentation for Linker::link() for details on the
934 expected meanings of parameters.
935 $skin: the Skin object
936 $target: the Title that the link is pointing to
937 &$text: the contents that the <a> tag should have (raw HTML); null means "de-
939 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
940 tive array form, with keys and values unescaped. Should be merged with de-
941 fault values, with a value of false meaning to suppress the attribute.
942 &$query: the query string to add to the generated URL (the bit after the "?"),
943 in associative array form, with keys and values unescaped.
944 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
945 &$ret: the value to return if your hook returns false.
947 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
948 just before the function returns a value. If you return true, an <a> element
949 with HTML attributes $attribs and contents $text will be returned. If you re-
950 turn false, $ret will be returned.
951 $skin: the Skin object
952 $target: the Title object that the link is pointing to
953 $options: the options. Will always include either 'known' or 'broken', and may
955 &$text: the final (raw HTML) contents of the <a> tag, after processing.
956 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
958 &$ret: the value to return if your hook returns false.
960 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
963 &$alt: the image's alt text
964 &$img: the new image HTML (if returning false)
966 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
969 &$text: the link text
970 &$link: the new link HTML (if returning false)
971 &$attribs: the attributes to be applied.
972 $linkType: The external link type
974 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
976 &$linksUpdate: the LinksUpdate object
978 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
980 &$linksUpdate: the LinksUpdate object
982 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
983 &$linksUpdate: the LinksUpdate object
985 'ListDefinedTags': When trying to find all defined tags.
986 &$tags: The list of tags.
988 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading
991 'LocalFile::getHistory': called before file history query performed
994 $fields: select fields
997 $join_conds: JOIN conditions
999 'LocalisationCacheRecache': Called when loading the localisation data into cache
1000 $cache: The LocalisationCache object
1001 $code: language code
1002 &$alldata: The localisation data from core and extensions
1004 'LoginAuthenticateAudit': a login attempt for a valid user account either
1005 succeeded or failed. No return data is accepted; this hook is for auditing only.
1006 $user: the User object being authenticated against
1007 $password: the password being submitted and found wanting
1008 $retval: a LoginForm class constant with authenticateUserData() return
1009 value (SUCCESS, WRONG_PASS, etc)
1011 'LogLine': Processes a single log entry on Special:Log
1012 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1013 logging.log_type database field.
1014 $log_action: string for the type of log action (e.g. 'delete', 'block',
1015 'create2'). Corresponds to logging.log_action database field.
1016 $title: Title object that corresponds to logging.log_namespace and
1017 logging.log_title database fields.
1018 $paramArray: Array of parameters that corresponds to logging.log_params field.
1019 Note that only $paramArray[0] appears to contain anything.
1020 &$comment: string that corresponds to logging.log_comment database field, and
1021 which is displayed in the UI.
1022 &$revert: string that is displayed in the UI, similar to $comment.
1023 $time: timestamp of the log entry (added in 1.12)
1025 'LogPageValidTypes': action being logged.
1026 DEPRECATED: Use $wgLogTypes
1027 &$type: array of strings
1029 'LogPageLogName': name of the logging page(s).
1030 DEPRECATED: Use $wgLogNames
1031 &$typeText: array of strings
1033 'LogPageLogHeader': strings used by wfMsg as a header.
1034 DEPRECATED: Use $wgLogHeaders
1035 &$headerText: array of strings
1037 'LogPageActionText': strings used by wfMsg as a header.
1038 DEPRECATED: Use $wgLogActions
1039 &$actionText: array of strings
1041 'MagicWordMagicWords': When defining new magic word.
1042 DEPRECATED: use $magicWords in a file listed in
1043 $wgExtensionMessagesFiles instead.
1044 $magicWords: array of strings
1046 'MagicWordwgVariableIDs': When definig new magic words IDs.
1047 $variableIDs: array of strings
1049 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1051 &$vars: variable (or multiple variables) to be added into the output
1052 of Skin::makeVariablesScript
1054 'MarkPatrolled': before an edit is marked patrolled
1055 $rcid: ID of the revision to be marked patrolled
1056 $user: the user (object) marking the revision as patrolled
1057 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1058 needs to be a sysop in order to mark an edit patrolled
1060 'MarkPatrolledComplete': after an edit is marked patrolled
1061 $rcid: ID of the revision marked as patrolled
1062 $user: user (object) who marked the edit patrolled
1063 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1064 must be a sysop to patrol the edit
1066 'MathAfterTexvc': after texvc is executed when rendering mathematics
1067 $mathRenderer: instance of MathRenderer
1068 $errmsg: error message, in HTML (string). Nonempty indicates failure
1069 of rendering the formula
1071 'MediaWikiPerformAction': Override MediaWiki::performAction().
1072 Use this to do something completely different, after the basic
1073 globals have been set up, but before ordinary actions take place.
1075 $article: $wgArticle
1078 $request: $wgRequest
1079 $mediaWiki: The $mediawiki object
1081 'MessagesPreLoad': When loading a message from the database
1082 $title: title of the message (string)
1083 $message: value (string), change it to the message you want to define
1085 'MessageCacheReplace': When a message page is changed.
1086 Useful for updating caches.
1087 $title: name of the page changed.
1088 $text: new contents of the page.
1090 'ModifyExportQuery': Modify the query used by the exporter.
1091 $db: The database object to be queried.
1092 &$tables: Tables in the query.
1093 &$conds: Conditions in the query.
1094 &$opts: Options for the query.
1095 &$join_conds: Join conditions for the query.
1097 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1098 been rendered (useful for adding more)
1099 Note: this is only run for the Monobook skin. To add items to the toolbox
1100 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
1102 $tools: array of tools
1104 'NewRevisionFromEditComplete': called when a revision was inserted
1106 $article: the article edited
1107 $rev: the new revision
1108 $baseID: the revision ID this was based off, if any
1109 $user: the editing user
1111 'NormalizeMessageKey': Called before the software gets the text of a message
1112 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1114 &$key: the message being looked up. Change this to something else to change
1115 what message gets displayed (string)
1116 &$useDB: whether or not to look up the message in the database (bool)
1117 &$langCode: the language code to get the message for (string) - or -
1118 whether to use the content language (true) or site language (false) (bool)
1119 &$transform: whether or not to expand variables and templates
1120 in the message (bool)
1122 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1123 &$changeslist: The OldChangesList instance.
1124 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1125 &$rc: The RecentChange object.
1127 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1128 Hooks can alter or append to the array of URLs for search & suggestion formats.
1129 &$urls: array of associative arrays with Url element attributes
1131 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1132 users and/or IP addresses too
1133 $otherBlockLink: An array with links to other block logs
1134 $ip: The requested IP address or username
1136 'OutputPageBeforeHTML': a page has been processed by the parser and
1137 the resulting HTML is about to be displayed.
1138 $parserOutput: the parserOutput (object) that corresponds to the page
1139 $text: the text that will be displayed, in HTML (string)
1141 'OutputPageCheckLastModified': when checking if the page has been modified
1142 since the last visit
1143 &$modifiedTimes: array of timestamps.
1144 The following keys are set: page, user, epoch
1146 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1147 $out: OutputPage instance (object)
1148 $parserOutput: parserOutput instance being added in $out
1150 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1151 categories. Implementations should return false if they generate the category
1152 links, so the default link generation is skipped.
1153 $out: OutputPage instance (object)
1154 $categories: associative array, keys are category names, values are category
1155 types ("normal" or "hidden")
1156 $links: array, intended to hold the result. Must be an associative array with
1157 category types as keys and arrays of HTML links as values.
1159 'PageHistoryBeforeList': When a history page list is about to be constructed.
1160 $article: the article that the history is loading for
1162 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1163 $row: the revision row for this line
1164 $s: the string representing this parsed line
1165 $classes: array containing the <li> element classes
1167 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1170 $queryInfo: the query parameters
1172 'PageRenderingHash': alter the parser cache option hash key
1173 A parser extension which depends on user options should install
1174 this hook and append its values to the key.
1175 $hash: reference to a hash key string which can be modified
1177 'ParserAfterStrip': Same as ParserBeforeStrip
1179 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1180 $parser: Parser object being used
1181 $text: text that'll be returned
1183 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1184 $parser: Parser object
1185 $text: text to parse
1186 $stripState: StripState instance being used
1188 'ParserBeforeStrip': Called at start of parsing time
1189 (no more strip, deprecated ?)
1190 $parser: parser object
1191 $text: text being parsed
1192 $stripState: stripState used (object)
1194 'ParserBeforeTidy': called before tidy and custom tags replacements
1195 $parser: Parser object being used
1198 'ParserClearState': called at the end of Parser::clearState()
1199 $parser: Parser object being cleared
1201 'ParserFirstCallInit': called when the parser initialises for the first time
1202 &$parser: Parser object being cleared
1204 'ParserGetVariableValueSwitch': called when the parser need the value of a
1206 $parser: Parser object
1207 $varCache: array to store the value in case of multiples calls of the
1209 $index: index (string) of the magic
1210 $ret: value of the magic word (the hook should set it)
1211 $frame: PPFrame object to use for expanding any template variables
1213 'ParserGetVariableValueTs': use this to change the value of the time for the
1214 {{LOCAL...}} magic word
1215 $parser: Parser object
1216 $time: actual time (timestamp)
1218 'ParserGetVariableValueVarCache': use this to change the value of the
1219 variable cache or return false to not use it
1220 $parser: Parser object
1221 $varCache: varaiable cache (array)
1223 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1224 include comments about size of the text parsed
1225 $parser: Parser object
1226 $limitReport: text that will be included (without comment tags)
1228 'ParserMakeImageParams': Called before the parser make an image link, use this
1229 to modify the parameters of the image.
1230 $title: title object representing the file
1231 $file: file object that will be used to create the image
1232 &$params: 2-D array of parameters
1234 'ParserTestParser': called when creating a new instance of Parser in
1235 maintenance/parserTests.inc
1236 $parser: Parser object created
1238 'ParserTestTables': alter the list of tables to duplicate when parser tests
1239 are run. Use when page save hooks require the presence of custom tables
1240 to ensure that tests continue to run properly.
1241 &$tables: array of table names
1243 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1244 my talk page, my contributions" etc).
1246 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1247 &$title: Title object representing the current page
1249 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1250 &$user : User performing the action
1251 $action : Action being performed
1252 &$result : Whether or not the action should be prevented
1253 Change $result and return false to give a definitive answer, otherwise
1254 the built-in rate limiting checks are used, if enabled.
1256 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1257 AJAX search suggestions. Put results into &$results outparam and return false.
1258 $ns : array of int namespace keys to search in
1259 $search : search term (not guaranteed to be conveniently normalized)
1260 $limit : maximum number of results to return
1261 &$results : out param: array of page names (strings)
1263 'PrefsEmailAudit': called when user changes his email address
1264 $user: User (object) changing his email address
1265 $oldaddr: old email address (string)
1266 $newaddr: new email address (string)
1268 'PrefsPasswordAudit': called when user changes his password
1269 $user: User (object) changing his passoword
1270 $newPass: new password
1271 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1273 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1274 $article: the title being (un)protected
1275 $output: a string of the form HTML so far
1277 'ProtectionForm::save': called when a protection form is submitted
1278 $article: the title being (un)protected
1279 $errorMsg: an html message string of an error
1281 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1282 $article: the page the form is shown for
1283 $out: OutputPage object
1285 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1286 &$obj: RawPage object
1287 &$text: The text that's going to be the output
1289 'RecentChange_save': called at the end of RecenChange::save()
1290 $recentChange: RecentChange object
1292 'RevisionInsertComplete': called after a revision is inserted into the DB
1293 &$revision: the Revision
1294 $data: the data stored in old_text. The meaning depends on $flags: if external
1295 is set, it's the URL of the revision text in external storage; otherwise,
1296 it's the revision text itself. In either case, if gzip is set, the revision
1298 $flags: a comma-delimited list of strings representing the options used. May
1299 include: utf8 (this will always be set for new revisions); gzip; external.
1301 'SearchUpdate': Prior to search update completion
1303 $namespace : Page namespace
1305 $text : Current text being indexed
1307 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1308 $allSearchTerms : Array of the search terms in all content languages
1309 &$titleResult : Outparam; the value to return. A Title object or null.
1311 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1312 $term : Search term string
1313 &$title : Outparam; set to $title object and return false for a match
1315 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1316 $term : Search term string
1317 &$title : Current Title object that is being returned (null if none found).
1319 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1320 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1321 in the $searchEngine->namespaces array.
1322 $query : Original query.
1323 &$parsed : Resultant query with the prefixes stripped.
1325 'SearchableNamespaces': An option to modify which namespaces are searchable.
1326 &$arr : Array of namespaces ($nsId => $name) which will be used.
1328 'SetupAfterCache': Called in Setup.php, after cache objects are set
1330 'ShowMissingArticle': Called when generating the output for a non-existent page
1331 $article: The article object corresponding to the page
1333 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1334 $text: Text being shown
1335 $title: Title of the custom script/stylesheet page
1336 $output: Current OutputPage object
1338 'ShowSearchHitTitle': Customise display of search hit title/link.
1339 &$title: Title to link to
1340 &$text: Text to use for the link
1341 $result: The search result
1342 $terms: The search terms entered
1343 $page: The SpecialSearch object.
1345 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1346 &$siteNotice: HTML returned as the sitenotice
1347 Return true to allow the normal method of notice selection/rendering to work,
1348 or change the value of $siteNotice and return false to alter it.
1350 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1351 &$siteNotice: HTML sitenotice
1352 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1354 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1356 &$text: bottomScripts Text
1357 Append to $text to add additional text/scripts after the stock bottom scripts.
1359 'SkinAfterContent': Allows extensions to add text after the page content and
1361 &$data: (string) Text to be printed out directly (without parsing)
1362 This hook should work in all skins. Just set the &$data variable to the text
1363 you're going to add.
1365 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1367 &$bar: Sidebar contents
1368 Modify $bar to add or modify sidebar portlets.
1370 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1371 $title: displayed page title
1372 $type: 'normal' or 'history' for old/diff views
1373 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1374 &$link: overridable HTML link to be passed into the message as $1
1376 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1378 &$subpages: Subpage links HTML
1379 If false is returned $subpages will be used instead of the HTML
1380 subPageSubtitle() generates.
1381 If true is returned, $subpages will be ignored and the rest of
1382 subPageSubtitle() will run.
1384 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab
1385 when showing a special page
1386 $sktemplate: SkinTemplate object
1387 $content_actions: array of tabs
1389 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1390 "permanent link" tab
1391 $sktemplate: SkinTemplate object
1392 $nav_urls: array of tabs
1394 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1395 &$content_actions: Content actions
1396 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1399 'SkinTemplateNavigation': Alter the structured navigation links in SkinTemplates
1400 &$sktemplate: SkinTemplate object
1401 &$links: Structured navigation links
1402 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1404 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1406 &$sktemplate: SkinTemplate object
1407 &$tpl: Template engine object
1409 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1410 $sktemplate: SkinTemplate object
1411 $res: set to true to prevent active tabs
1413 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1416 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1417 You can either create your own array, or alter the parameters for
1419 &$sktemplate: The SkinTemplate instance.
1420 $title: Title instance for the page.
1421 $message: Visible label of tab.
1422 $selected: Whether this is a selected tab.
1423 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1424 &$classes: Array of CSS classes to apply.
1425 &$query: Query string to add to link.
1427 &$result: Complete assoc. array if you want to return true.
1429 'SkinTemplateTabs': called when finished to build the actions tabs
1430 $sktemplate: SkinTemplate object
1431 $content_actions: array of tabs
1433 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1434 been rendered (useful for adding more)
1435 $tools: array of tools
1437 'SoftwareInfo': Called by Special:Version for returning information about
1439 $software: The array of software in format 'name' => 'version'.
1440 See SpecialVersion::softwareInformation()
1442 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1443 $id: User identifier
1445 'SpecialListusersDefaultQuery': called right before the end of
1446 UsersPager::getDefaultQuery()
1447 $pager: The UsersPager instance
1448 $query: The query array to be returned
1450 'SpecialListusersFormatRow': called right before the end of
1451 UsersPager::formatRow()
1452 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1453 $row: Database row object
1455 'SpecialListusersHeader': called before closing the <fieldset> in
1456 UsersPager::getPageHeader()
1457 $pager: The UsersPager instance
1458 $out: The header HTML
1460 'SpecialListusersHeaderForm': called before adding the submit button in
1461 UsersPager::getPageHeader()
1462 $pager: The UsersPager instance
1463 $out: The header HTML
1465 'SpecialListusersQueryInfo': called right before the end of
1466 UsersPager::getQueryInfo()
1467 $pager: The UsersPager instance
1468 $query: The query array to be returned
1470 'SpecialMovepageAfterMove': called after moving a page
1471 $movePage: MovePageForm object
1472 $oldTitle: old title (object)
1473 $newTitle: new title (object)
1475 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1476 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1477 $opts: FormOptions object containing special page options
1478 &$conds: array of WHERE conditionals for query
1480 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1481 hook to remove a core special page
1482 $list: list (array) of core special pages
1484 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1485 use this to change some selection criteria or substitute a different title
1486 &$randstr: The random number from wfRandom()
1487 &$isRedir: Boolean, whether to select a redirect or non-redirect
1488 &$namespaces: An array of namespace indexes to get the title from
1489 &$extra: An array of extra SQL statements
1490 &$title: If the hook returns false, a Title object to use instead of the
1491 result from the normal query
1493 'SpecialRecentChangesPanel': called when building form options in
1494 SpecialRecentChanges
1495 &$extraOpts: array of added items, to which can be added
1496 $opts: FormOptions for this request
1498 'SpecialRecentChangesQuery': called when building sql query for
1499 SpecialRecentChanges
1500 &$conds: array of WHERE conditionals for query
1501 &$tables: array of tables to be queried
1502 &$join_conds: join conditions for the tables
1503 $opts: FormOptions for this request
1504 &$query_options: array of options for the database request
1506 'SpecialSearchGomatch': called when user clicked the "Go" button and the target
1508 &$title: title object generated from the text entred by the user
1510 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1511 target doesn't exist
1512 &$title: title object generated from the text entred by the user
1514 'SpecialSearchProfiles': allows modification of search profiles
1515 &$profiles: profiles, which can be modified.
1517 'SpecialSearchResults': called before search result display when there
1519 $term: string of search term
1520 &$titleMatches: empty or SearchResultSet object
1521 &$textMatches: empty or SearchResultSet object
1523 'SpecialSearchNoResults': called before search result display when there are
1525 $term: string of search term
1527 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1528 &$extraStats: Array to save the new stats
1529 ( $extraStats['<name of statistic>'] => <value>; )
1531 'SpecialUploadComplete': Called after successfully uploading a file from
1533 $form: The SpecialUpload object
1535 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1536 use this to change the tables headers
1537 $extTypes: associative array of extensions types
1539 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1540 &$conds: array of WHERE conditionals for query
1541 &$tables: array of tables to be queried
1542 &$join_conds: join conditions for the tables
1543 &$fields: array of query fields
1545 'TitleArrayFromResult': called when creating an TitleArray object from a
1547 &$titleArray: set this to an object to override the default object returned
1548 $res: database result used to create the object
1550 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1551 that can be applied.
1552 $title: The title in question.
1553 &$types: The types of protection available.
1555 'TitleMoveComplete': after moving an article (title)
1558 $user: user who did the move
1559 $pageid: database ID of the page that's been moved
1560 $redirid: database ID of the created redirect
1562 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1563 $title: title object related to the revision
1564 $rev: revision (object) that will be viewed
1566 'UnknownAction': An unknown "action" has occured (useful for defining
1568 $action: action name
1569 $article: article "acted on"
1571 'UnwatchArticle': before a watch is removed from an article
1572 $user: user watching
1573 $article: article object to be removed
1575 'UnwatchArticle': after a watch is removed from an article
1576 $user: user that was watching
1577 $article: article object removed
1579 'UnwatchArticleComplete': after a watch is removed from an article
1580 $user: user that watched
1581 $article: article object that was watched
1583 'UploadForm:initial': before the upload form is generated
1584 $form: UploadForm object
1585 You might set the member-variables $uploadFormTextTop and
1586 $uploadFormTextAfterSummary to inject text (HTML) either before
1587 or after the editform.
1589 'UploadForm:BeforeProcessing': DEPRECATED! at the beginning of processUpload()
1590 $form: UploadForm object
1591 Lets you poke at member variables like $mUploadDescription before the
1594 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1595 $type: (string) the requested upload type
1596 &$className: the class name of the Upload instance to be created
1598 'UploadComplete': when Upload completes an upload
1599 &$upload: an UploadBase child instance
1601 'UploadFormInitDescriptor': after the descriptor for the upload form as been
1603 $descriptor: (array) the HTMLForm descriptor
1605 'UploadFormSourceDescriptors': after the standard source inputs have been
1606 added to the descriptor
1607 $descriptor: (array) the HTMLForm descriptor
1609 'UploadVerification': additional chances to reject an uploaded file
1610 string $saveName: destination file name
1611 string $tempName: filesystem path to the temporary file for checks
1612 string &$error: output: message key for message to show if upload canceled
1613 by returning false. May also be an array, where the first element
1614 is the message key and the remaining elements are used as parameters to
1617 'UploadComplete': Upon completion of a file upload
1618 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1619 $uploadBase->getLocalFile().
1621 'User::mailPasswordInternal': before creation and mailing of a user's new
1623 $user: the user who sent the message out
1624 $ip: IP of the user who sent the message out
1625 $u: the account whose new password will be set
1627 'UserArrayFromResult': called when creating an UserArray object from a
1629 &$userArray: set this to an object to override the default object returned
1630 $res: database result used to create the object
1632 'userCan': To interrupt/advise the "user can do X to Y article" check.
1633 If you want to display an error message, try getUserPermissionsErrors.
1634 $title: Title object being checked against
1635 $user : Current user object
1636 $action: Action being checked
1637 $result: Pointer to result returned if hook returns false. If null is returned,
1638 userCan checks are continued by internal code.
1640 'UserCanSendEmail': To override User::canSendEmail() permission check
1641 $user: User (object) whose permission is being checked
1642 &$canSend: bool set on input, can override on output
1644 'UserClearNewTalkNotification': called when clearing the
1645 "You have new messages!" message, return false to not delete it
1646 $user: User (object) that'll clear the message
1648 'UserComparePasswords': called when checking passwords, return false to
1649 override the default password checks
1650 &$hash: String of the password hash (from the database)
1651 &$password: String of the plaintext password the user entered
1652 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1654 &$result: If the hook returns false, this Boolean value will be checked to
1655 determine if the password was valid
1657 'UserCreateForm': change to manipulate the login form
1658 $template: SimpleTemplate instance for the form
1660 'UserCryptPassword': called when hashing a password, return false to implement
1661 your own hashing method
1662 &$password: String of the plaintext password to encrypt
1663 &$salt: String of the password salt or Boolean false if no salt is provided
1664 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1666 &$hash: If the hook returns false, this String will be used as the hash
1668 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1669 $user: User to get groups for
1670 &$groups: Current effective groups
1672 'UserGetAllRights': after calculating a list of all available rights
1673 &$rights: Array of rights, which may be added to.
1675 'UserGetEmail': called when getting an user email address
1677 &$email: email, change this to override local email
1679 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1680 email authentification
1682 &$timestamp: timestamp, change this to override local email authentification
1685 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1686 &$groups: List of implicit (automatically-assigned) groups
1688 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1689 &$reservedUsernames: $wgReservedUsernames
1691 'UserGetRights': Called in User::getRights()
1692 $user: User to get rights for
1693 &$rights: Current rights
1695 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
1697 $user: User in question
1698 $title: Title of the page in question
1699 &$blocked: Out-param, whether or not the user is blocked from that page.
1700 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
1701 own user talk pages.
1703 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
1705 $ip: User's IP address
1706 &$blocked: Whether the user is blocked, to be modified by the hook
1708 'UserLoadAfterLoadFromSession': called to authenticate users on
1709 external/environmental means; occurs after session is loaded
1710 $user: user object being loaded
1712 'UserLoadDefaults': called when loading a default user
1716 'UserLoadFromDatabase': called when loading a user from the database
1718 &$s: database query object
1720 'UserLoadFromSession': called to authenticate users on external/environmental
1721 means; occurs before session is loaded
1722 $user: user object being loaded
1723 &$result: set this to a boolean value to abort the normal authentification
1726 'UserLoadOptions': when user options/preferences are being loaded from
1729 &$options: Options, can be modified.
1731 'UserLoginComplete': after a user has logged in
1732 $user: the user object that was created on login
1733 $inject_html: Any HTML to inject after the "logged in" message.
1735 'UserLoginForm': change to manipulate the login form
1736 $template: SimpleTemplate instance for the form
1738 'UserLoginMailPassword': Block users from emailing passwords
1739 $name: the username to email the password of.
1740 &$error: out-param - the error message to return.
1742 'UserLogout': before a user logs out
1743 $user: the user object that is about to be logged out
1745 'UserLogoutComplete': after a user has logged out
1746 $user: the user object _after_ logout (won't have name, ID, etc.)
1747 $inject_html: Any HTML to inject after the "logged out" message.
1748 $oldName: name of the user before logout (string)
1750 'UserRights': After a user's group memberships are changed
1751 $user : User object that was changed
1752 $add : Array of strings corresponding to groups added
1753 $remove: Array of strings corresponding to groups removed
1755 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
1757 $user: user retrieving new talks messages
1758 $talks: array of new talks page(s)
1760 'UserSaveSettings': called when saving user settings
1763 'UserSaveOptions': Called just before saving user preferences/options.
1765 &$options: Options, modifiable
1767 'UserSetCookies': called when setting user cookies
1769 &$session: session array, will be added to $_SESSION
1770 &$cookies: cookies array mapping cookie name to its value
1772 'UserSetEmail': called when changing user email address
1774 &$email: new email, change this to override new email address
1776 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
1777 of email authentification
1779 &$timestamp: new timestamp, change this to override local email
1780 authentification timestamp
1782 'UserToggles': called when initialising User::$mToggles, use this to add
1784 $toggles: array of toggles to add
1786 'WantedPages::getSQL': called in WantedPagesPage::getSQL(), can be used to
1787 alter the SQL query which gets the list of wanted pages
1788 &$wantedPages: WantedPagesPage object
1789 &$sql: raw SQL query used to get the list of wanted pages
1791 'WatchArticle': before a watch is added to an article
1792 $user: user that will watch
1793 $article: article object to be watched
1795 'WatchArticleComplete': after a watch is added to an article
1796 $user: user that watched
1797 $article: article object watched
1799 'WatchlistEditorBuildRemoveLine': when building remove lines in
1800 Special:Watchlist/edit
1801 &$tools: array of extra links
1802 $title: Title object
1803 $redirect: whether the page is a redirect
1806 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
1808 One, and only one hook should set this, and return false.
1809 &$tables: Database tables to use in the SELECT query
1810 &$opts: Options to use for the query
1811 &$join: Join conditions
1813 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
1814 query pages to be updated with maintenance/updateSpecialPages.php
1815 $query: $wgQueryPages itself
1817 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
1818 metadata to be added.
1819 $obj: The XmlDumpWriter object.
1820 &$out: The output string.
1821 $row: The database row for the page.
1822 $title: The title of the page.
1824 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
1826 $obj: The XmlDumpWriter object.
1827 &$out: The text being output.
1828 $row: The database row for the revision.
1829 $text: The revision text.
1831 More hooks might be available but undocumented, you can execute
1832 ./maintenance/findhooks.php to find hidden one.