Rm old options from commandLine.inc days
[mediawiki.git] / docs / hooks.txt
blobc2a5f6dca65f776ee8cad2af42a8acbcfdb1778a
1 hooks.txt
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.
6 ==Glossary==
8 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',
14      'ArticleDelete'.
16 hook
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.
20 hook function
21      The function part of a hook.
23 ==Rationale==
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);
42                 }
44                 if ($wgCapitalizeTitle) {
45                         wfCapitalizeTitle($article);
46                 }
48                 # code to actually show the article goes here
49         }
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);
60                 }
62                 if ($wgCapitalizeTitle) {
63                         wfCapitalizeTitle($article);
64                 }
66                 # code to actually show the article goes here
68                 if ($wgNotifyArticle) {
69                         wfNotifyArticleShow($article));
70                 }
71         }
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));
83                 }
84         }
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
94 file:
96         function reverseArticleTitle($article) {
97                 # ...
98         }
100         function reverseForExport($article) {
101                 # ...
102         }
104 The setup function for the extension just has to add its hook functions to the
105 appropriate events:
107         setupTitleReversingExtension() {
108                 global $wgHooks;
110                 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111                 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112                 $wgHooks['ArticleExport'][] = 'reverseForExport';
113         }
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
126 just leave it out.
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.
131 ==Writing hooks==
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:
154         # function, no data
155         someFunction($param1, $param2)
156         # function with data
157         someFunction($someData, $param1, $param2)
159         # object only
160         $object->onEventName($param1, $param2)
161         # object with method
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
185            function should skip
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) {
194                 # log user into LDAP
195                 return false;
196         }
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.
205 ==Using hooks==
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
210         class Article {
211                 # ...
212                 function protect() {
213                         global $wgUser;
214                         if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
215                                 # protect the article
216                                 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
217                         }
218                 }
219         }
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
230 MediaWiki 1.4rc1.
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 'AbortAutoAccount': Return false to cancel automated local account creation, where normally authentication against an external auth plugin would be creating a local account.
238 $user: the User object about to be created (read-only, incomplete)
239 &$abortMsg: out parameter: name of error message to be displayed to user
241 'AbortAutoblock': Return false to cancel an autoblock.
242 $autoblockip: The IP going to be autoblocked.
243 $block: The block from which the autoblock is coming.
245 'AbortDiffCache': Can be used to cancel the caching of a diff
246 &$diffEngine: DifferenceEngine object
248 'AbortLogin': Return false to cancel account login.
249 $user: the User object being authenticated against
250 $password: the password being submitted, not yet checked for validity
251 &$retval: a LoginForm class constant to return from authenticateUserData();
252           default is LoginForm::ABORTED. Note that the client may be using
253           a machine API rather than the HTML user interface.
254 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
256 'AbortMove': allows to abort moving an article (title)
257 $old: old title
258 $nt: new title
259 $user: user who is doing the move
260 $err: error message
261 $reason: the reason for the move (added in 1.13)
263 'AbortNewAccount': Return false to cancel explicit account creation.
264 $user: the User object about to be created (read-only, incomplete)
265 &$msg: out parameter: name of error message to display on abort
267 'ActionBeforeFormDisplay': before executing the HTMLForm object
268 $name: name of the action
269 &$form: HTMLForm object
270 $article: Article object
272 'ActionModifyFormFields': before creating an HTMLForm object for a page action;
273         allows to change the fields on the form that will be generated
274 $name: name of the action
275 &$fields: HTMLForm descriptor array
276 $article: Article object
278 'AddNewAccount': after a user account is created
279 $user: the User object that was created. (Parameter added in 1.7)
280 $byEmail: true when account was created "by email" (added in 1.12)
282 'AfterImportPage': When a page import is completed
283 $title: Title under which the revisions were imported
284 $origTitle: Title provided by the XML file
285 $revCount: Number of revisions in the XML file
286 $sRevCount: Number of sucessfully imported revisions
287 $pageInfo: associative array of page information
289 'AjaxAddScript': Called in output page just before the initialisation
290 of the javascript ajax engine. The hook is only called when ajax
291 is enabled ( $wgUseAjax = true; ).
293 'AlternateEdit': before checking if an user can edit a page and
294 before showing the edit form ( EditPage::edit() ). This is triggered
295 on &action=edit.
296 $EditPage: the EditPage object
298 'AlternateUserMailer': Called before mail is sent so that mail could
299 be logged (or something else) instead of using PEAR or PHP's mail().
300 Return false to skip the regular method of sending mail.  Return a
301 string to return a php-mail-error message containing the error.
302 Returning true will continue with sending email in the regular way.
303 $headers: Associative array of headers for the email
304 $to: MailAddress object or array
305 $from: From address
306 $subject: Subject of the email
307 $body: Body of the message
309 'APIAfterExecute': after calling the execute() method of an API module.
310 Use this to extend core API modules.
311 &$module: Module object
313 'APIEditBeforeSave': before saving a page with api.php?action=edit,
314 after processing request parameters. Return false to let the request
315 fail, returning an error message or an <edit result="Failure"> tag
316 if $resultArr was filled.
317 $EditPage : the EditPage object
318 $text : the new text of the article (has yet to be saved)
319 &$resultArr : data in this array will be added to the API result
321 'APIGetAllowedParams': use this hook to modify a module's parameters.
322 &$module: Module object
323 &$params: Array of parameters
325 'APIGetParamDescription': use this hook to modify a module's parameter
326 descriptions.
327 &$module: Module object
328 &$desc: Array of parameter descriptions
330 'APIQueryAfterExecute': after calling the execute() method of an
331 action=query submodule. Use this to extend core API modules.
332 &$module: Module object
334 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
335 method of an action=query submodule. Use this to extend core API modules.
336 &$module: Module object
337 &$resultPageSet: ApiPageSet object
339 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
340 Every token has an action, which will be used in the intoken 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($pageid, $title)
344 where $pageid is the page ID of the page the token is requested for
345 and $title is the associated Title object. In the hook, just add
346 your callback to the $tokenFunctions array and return true (returning
347 false makes no sense)
348 $tokenFunctions: array(action => callback)
350 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
351 Every token has an action, which will be used in the rvtoken parameter
352 and in the output (actiontoken="..."), and a callback function which
353 should return the token, or false if the user isn't allowed to obtain
354 it. The prototype of the callback function is func($pageid, $title, $rev)
355 where $pageid is the page ID of the page associated to the revision the
356 token is requested for, $title the associated Title object and $rev the
357 associated Revision object. In the hook, just add your callback to the
358 $tokenFunctions array and return true (returning false makes no sense)
359 $tokenFunctions: array(action => callback)
361 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
362 list=recentchanges.
363 Every token has an action, which will be used in the rctoken parameter
364 and in the output (actiontoken="..."), and a callback function which
365 should return the token, or false if the user isn't allowed to obtain
366 it. The prototype of the callback function is func($pageid, $title, $rc)
367 where $pageid is the page ID of the page associated to the revision the
368 token is requested for, $title the associated Title object and $rc the
369 associated RecentChange object. In the hook, just add your callback to the
370 $tokenFunctions array and return true (returning false makes no sense)
371 $tokenFunctions: array(action => callback)
373 'APIQuerySiteInfoGeneralInfo': use this hook to add extra information to
374 the sites general information.
375 $module: the current ApiQuerySiteInfo module
376 &$results: array of results, add things here
378 'APIQueryUsersTokens': use this hook to add custom token to list=users.
379 Every token has an action, which will be used in the ustoken parameter
380 and in the output (actiontoken="..."), and a callback function which
381 should return the token, or false if the user isn't allowed to obtain
382 it. The prototype of the callback function is func($user) where $user
383 is the User object. In the hook, just add your callback to the
384 $tokenFunctions array and return true (returning false makes no sense)
385 $tokenFunctions: array(action => callback)
387 'ApiRsdServiceApis': Add or remove APIs from the RSD services list.
388 Each service should have its own entry in the $apis array and have a
389 unique name, passed as key for the array that represents the service data.
390 In this data array, the key-value-pair identified by the apiLink key is 
391 required.
392 &$apis: array of services
394 'ArticleAfterFetchContent': after fetching content of an article from
395 the database
396 $article: the article (object) being loaded from the database
397 $content: the content (string) of the article
399 'ArticleConfirmDelete': before writing the confirmation form for article
400         deletion
401 $article: the article (object) being deleted
402 $output: the OutputPage object ($wgOut)
403 &$reason: the reason (string) the article is being deleted
405 'ArticleContentOnDiff': before showing the article content below a diff.
406 Use this to change the content in this area or how it is loaded.
407  $diffEngine: the DifferenceEngine
408  $output: the OutputPage object ($wgOut)
410 'ArticleDelete': before an article is deleted
411 $article: the WikiPage (object) being deleted
412 $user: the user (object) deleting the article
413 $reason: the reason (string) the article is being deleted
414 $error: if the deletion was prohibited, the (raw HTML) error message to display
415   (added in 1.13)
417 'ArticleDeleteComplete': after an article is deleted
418 $article: the WikiPage that was deleted
419 $user: the user that deleted the article
420 $reason: the reason the article was deleted
421 $id: id of the article that was deleted
423 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
424 was changed
425 $article: WikiPage (object) of the user talk page
427 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
428 article has been changed
429 $article: the WikiPage (object)
430 $editInfo: data holder that includes the parser output ($editInfo->output) for
431 that page after the change
432 $changed: bool for if the page was changed
434 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
435 recentchanges table, return false to not delete old entries
436 $article: WikiPage (object) being modified
438 'ArticleFromTitle': when creating an article object from a title object using
439 Wiki::articleFromTitle()
440 $title: title (object) used to create the article object
441 $article: article (object) that will be returned
443 'ArticleInsertComplete': After a new article is created
444 $article: WikiPage created
445 $user: User creating the article
446 $text: New content
447 $summary: Edit summary/comment
448 $isMinor: Whether or not the edit was marked as minor
449 $isWatch: (No longer used)
450 $section: (No longer used)
451 $flags: Flags passed to Article::doEdit()
452 $revision: New Revision of the article
454 'ArticleMergeComplete': after merging to article using Special:Mergehistory
455 $targetTitle: target title (object)
456 $destTitle: destination title (object)
458 'ArticlePageDataAfter': after loading data of an article from the database
459 $article: WikiPage (object) whose data were loaded
460 $row: row (object) returned from the database server
462 'ArticlePageDataBefore': before loading data of an article from the database
463 $article: WikiPage (object) that data will be loaded
464 $fields: fileds (array) to load from the database
466 'ArticlePrepareTextForEdit': called when preparing text to be saved
467 $article: the WikiPage being saved
468 $popts: parser options to be used for pre-save transformation
470 'ArticleProtect': before an article is protected
471 $article: the WikiPage being protected
472 $user: the user doing the protection
473 $protect: boolean whether this is a protect or an unprotect
474 $reason: Reason for protect
475 $moveonly: boolean whether this is for move only or not
477 'ArticleProtectComplete': after an article is protected
478 $article: the WikiPage that was protected
479 $user: the user who did the protection
480 $protect: boolean whether it was a protect or an unprotect
481 $reason: Reason for protect
482 $moveonly: boolean whether it was for move only or not
484 'ArticlePurge': before executing "&action=purge"
485 $article: WikiPage (object) to purge
487 'ArticleRevisionVisibilitySet': called when changing visibility of one or more
488 revision of an article
489 &$title: title object of the article
491 'ArticleRevisionUndeleted': after an article revision is restored
492 $title: the article title
493 $revision: the revision
494 $oldPageID: the page ID of the revision when archived (may be null)
496 'ArticleRollbackComplete': after an article rollback is completed
497 $article: the WikiPage that was edited
498 $user: the user who did the rollback
499 $revision: the revision the page was reverted back to
500 $current: the reverted revision
502 'ArticleSave': before an article is saved
503 $article: the WikiPage (object) being saved
504 $user: the user (object) saving the article
505 $text: the new article text
506 $summary: the article summary (comment)
507 $isminor: minor flag
508 $iswatch: watch flag
509 $section: section #
511 'ArticleSaveComplete': After an article has been updated
512 $article: WikiPage modified
513 $user: User performing the modification
514 $text: New content
515 $summary: Edit summary/comment
516 $isMinor: Whether or not the edit was marked as minor
517 $isWatch: (No longer used)
518 $section: (No longer used)
519 $flags: Flags passed to Article::doEdit()
520 $revision: New Revision of the article
521 $baseRevId: the rev ID (or false) this edit was based on
523 'ArticleUndelete': When one or more revisions of an article are restored
524 $title: Title corresponding to the article restored
525 $create: Whether or not the restoration caused the page to be created
526 (i.e. it didn't exist before)
527 $comment: The comment associated with the undeletion.
529 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
530 before the user is redirected back to the page
531 &$article: the article
532 &$sectionanchor: The section anchor link (e.g. "#overview" )
533 &$extraq: Extra query parameters which can be added via hooked functions
535 'ArticleViewFooter': After showing the footer section of an ordinary page view
536 $article: Article object
538 'ArticleViewHeader': Before the parser cache is about to be tried for article
539 viewing.
540 &$article: the article
541 &$pcache: whether to try the parser cache or not
542 &$outputDone: whether the output for this page finished or not
544 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
545 follwed an redirect
546 $article: target article (object)
548 'ArticleViewCustom': allows to output the text of the article in a different format than wikitext
549 $text: text of the page
550 $title: title of the page
551 $output: reference to $wgOut
553 'AuthPluginAutoCreate': Called when creating a local account for an user logged
554 in from an external authentication method
555 $user: User object created locally
557 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
558 Gives a chance for an extension to set it programattically to a variable class.
559 &$auth: the $wgAuth object, probably a stub
561 'AutopromoteCondition': check autopromote condition for user.
562 $type: condition type
563 $args: arguments
564 $user: user
565 $result: result of checking autopromote condition
567 'BacklinkCacheGetPrefix': allows to set prefix for a spefific link table
568 $table: table name
569 &$prefix: prefix
571 'BacklinkCacheGetConditions': allows to set conditions for query when links to certain title
572 are fetched
573 $table: table name
574 $title: title of the page to which backlinks are sought
575 &$conds: query conditions
577 'BadImage': When checking against the bad image list
578 $name: Image name being checked
579 &$bad: Whether or not the image is "bad"
581 Change $bad and return false to override. If an image is "bad", it is not
582 rendered inline in wiki pages or galleries in category pages.
584 'BeforeInitialize': before anything is initialized in performRequestForTitle()
585 &$title: Title being used for request
586 &$article: The associated Article object
587 &$output: OutputPage object
588 &$user: User
589 $request: WebRequest object
590 $mediaWiki: Mediawiki object
592 'BeforePageDisplay': Prior to outputting a page
593 &$out: OutputPage object
594 &$skin: Skin object
596 'BeforeParserFetchFileAndTitle': before an image is rendered by Parser
597 $parser: Parser object
598 $nt: the image title
599 &$options: array of options to RepoGroup::findFile
600 &$descQuery: query string to add to thumbnail URL
602 If 'broken' is a key in $options then the file will appear as a broken thumbnail.
604 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
605 $parser: Parser object
606 $title: title of the template
607 &$skip: skip this template and link it?
608 &$id: the id of the revision being parsed
610 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
611 &$parser: Parser object
612 &$ig: ImageGallery object
614 'BeforeWelcomeCreation': before the welcomecreation message is displayed to a newly created user 
615 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen to a newly created user account
616 &$injected_html: Any HTML to inject after the "logged in" message of a newly created user account 
618 'BitmapHandlerTransform': before a file is transformed, gives extension the 
619 possibility to transform it themselves
620 $handler: BitmapHandler 
621 $image: File
622 &$scalerParams: Array with scaler parameters 
623 &$mto: null, set to a MediaTransformOutput
625 'PerformRetroactiveAutoblock': called before a retroactive autoblock is applied to a user
626 $block: Block object (which is set to be autoblocking)
627 &$blockIds: Array of block IDs of the autoblock
629 'BlockIp': before an IP address or user is blocked
630 $block: the Block object about to be saved
631 $user: the user _doing_ the block (not the one being blocked)
633 'BlockIpComplete': after an IP address or user is blocked
634 $block: the Block object that was saved
635 $user: the user who did the block (not the one being blocked)
637 'BookInformation': Before information output on Special:Booksources
638 $isbn: ISBN to show information for
639 $output: OutputPage object in use
641 'CanonicalNamespaces': For extensions adding their own namespaces or altering the defaults
642 &$namespaces: Array of namespace numbers with corresponding canonical names
644 'CategoryPageView': before viewing a categorypage in CategoryPage::view
645 $catpage: CategoryPage instance
647 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
648 &$changesList: ChangesList instance.
649 &$articlelink: HTML of link to article (already filled-in).
650 &$s:           HTML of row that is being constructed.
651 &$rc:          RecentChange instance.
652 $unpatrolled:  Whether or not we are showing unpatrolled changes.
653 $watched:      Whether or not the change is watched by the user.
655 'Collation::factory': Called if $wgCategoryCollation is an unknown collation
656 $collationName: Name of the collation in question
657 &$collationObject: Null. Replace with a subclass of the Collation class that implements
658 the collation given in $collationName.
660 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
661 $user: user (object) whose email is being confirmed
663 'ContribsPager::getQueryInfo': Before the contributions query is about to run
664 &$pager: Pager object for contributions
665 &$queryInfo: The query for the contribs Pager
667 'ContributionsLineEnding': Called before a contributions HTML line is finished
668 $page: SpecialPage object for contributions
669 $ret: the HTML line
670 $row: the DB row for this line
672 'ContributionsToolLinks': Change tool links above Special:Contributions
673 $id: User identifier
674 $title: User page title
675 &$tools: Array of tool links
677 'CustomEditor': When invoking the page editor
678 $article: Article being edited
679 $user: User performing the edit
681 Return true to allow the normal editor to be used, or false
682 if implementing a custom editor, e.g. for a special namespace,
683 etc.
685 'DatabaseOraclePostInit': Called after initialising an Oracle database
686 &$db: the DatabaseOracle object
688 'Debug': called when outputting a debug log line via wfDebug() or wfDebugLog()
689 $text: plaintext string to be output
690 $group: null or a string naming a logging group (as defined in $wgDebugLogGroups)
692 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
693 $title: the diff page title (nullable)
694 &$oldId: the actual old Id to use in the diff
695 &$newId: the actual new Id to use in the diff (0 means current)
696 $old: the ?old= param value from the url
697 $new: the ?new= param value from the url
699 'DiffViewHeader': called before diff display
700 $diff: DifferenceEngine object that's calling
701 $oldRev: Revision object of the "old" revision (may be null/invalid)
702 $newRev: Revision object of the "new" revision
704 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
705 an article
706 $article: article (object) being viewed
707 $oldid: oldid (int) being viewed
709 'DoEditSectionLink': Override the HTML generated for section edit links
710 $skin: Skin object rendering the UI
711 $title: Title object for the title being linked to (may not be the same as
712   $wgTitle, if the section is included from a template)
713 $section: The designation of the section being pointed to, to be included in
714   the link, like "&section=$section"
715 $tooltip: The default tooltip.  Escape with htmlspecialchars() before using.
716   By default, this is wrapped in the 'editsectionhint' message.
717 &$result: The HTML to return, prefilled with the default plus whatever other
718   changes earlier hooks have made
719 $lang: The language code to use for the link in the wfMsg* functions
721 'EditFilter': Perform checks on an edit
722 $editor: Edit form (see includes/EditPage.php)
723 $text: Contents of the edit box
724 $section: Section being edited
725 &$error: Error message to return
726 $summary: Edit summary for page
728 'EditFilterMerged': Post-section-merge edit filter
729 $editor: EditPage instance (object)
730 $text: content of the edit box
731 &$error: error message to return
732 $summary: Edit summary for page
734 'EditFormPreloadText': Allows population of the edit form when creating
735 new pages
736 &$text: Text to preload with
737 &$title: Title object representing the page being created
739 'EditFormInitialText': Allows modifying the edit form when editing existing
740 pages
741 $editPage: EditPage     object
743 'EditPage::attemptSave': called before an article is
744 saved, that is before Article::doEdit() is called
745 $editpage_Obj: the current EditPage object
747 'EditPage::importFormData': allow extensions to read additional data
748 posted in the form
749 $editpage: EditPage instance 
750 $request: Webrequest
751 return value is ignored (should always return true)
753 'EditPage::showEditForm:fields': allows injection of form field into edit form
754 &$editor: the EditPage instance for reference
755 &$out: an OutputPage instance to write to
756 return value is ignored (should always return true)
758 'EditPage::showEditForm:initial': before showing the edit form
759 $editor: EditPage instance (object)
761 Return false to halt editing; you'll need to handle error messages, etc.
762 yourself. Alternatively, modifying $error and returning true will cause the
763 contents of $error to be echoed at the top of the edit form as wikitext.
764 Return true without altering $error to allow the edit to proceed.
766 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
767 when there's an edit conflict.  Return false to halt normal diff output; in
768 this case you're responsible for computing and outputting the entire "conflict"
769 part, i.e., the "difference between revisions" and "your text" headers and
770 sections.
771 &$editor: EditPage instance
772 &$out: OutputPage instance
774 'EditPageBeforeEditButtons':  allows modifying the edit buttons below the
775 textarea in the edit form
776 &$editpage: The current EditPage object
777 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
778 &$tabindex: HTML tabindex of the last edit check/button
780 'EditPageBeforeEditChecks':  allows modifying the edit checks below the
781 textarea in the edit form
782 &$editpage: The current EditPage object
783 &$checks: Array of edit checks like "watch this page"/"minor edit"
784 &$tabindex: HTML tabindex of the last edit check/button
786 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
787 textarea in the edit form
788 &$toolbar: The toolbar HTMl
790 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
791 $title: title of page being edited
792 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
794 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
795 "Show changes"
796 $editPage: EditPage object
797 &$newtext: wikitext that will be used as "your version"
799 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed
800 $editPage: EditPage object
801 &$toparse: wikitext that will be parsed
803 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
804 &$editpage: The current EditPage object
805 &$res: the HTML of the error text
807 'EditPageTosSummary':  Give a chance for site and per-namespace customizations
808 of terms of service summary link that might exist separately from the copyright
809 notice.
810 $title: title of page being edited
811 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
813 'EditSectionLink': Do not use, use DoEditSectionLink instead.
814 $skin: Skin rendering the UI
815 $title: Title being linked to
816 $section: Section to link to
817 $link: Default link
818 &$result: Result (alter this to override the generated links)
819 $lang: The language code to use for the link in the wfMsg* functions
821 'EmailConfirmed': When checking that the user's email address is "confirmed"
822 $user: User being checked
823 $confirmed: Whether or not the email address is confirmed
824 This runs before the other checks, such as anonymity and the real check; return
825 true to allow those checks to occur, and false if checking is done.
827 'EmailUser': before sending email from one user to another
828 $to: address of receiving user
829 $from: address of sending user
830 $subject: subject of the mail
831 $text: text of the mail
833 'EmailUserCC': before sending the copy of the email to the author
834 $to: address of receiving user
835 $from: address of sending user
836 $subject: subject of the mail
837 $text: text of the mail
839 'EmailUserComplete': after sending email from one user to another
840 $to: address of receiving user
841 $from: address of sending user
842 $subject: subject of the mail
843 $text: text of the mail
845 'EmailUserForm': after building the email user form object
846 $form: HTMLForm object
848 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
849 $user: The user who is trying to email another user.
850 $editToken: The user's edit token.
851 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
853 'exemptFromAccountCreationThrottle': Exemption from the account creation throttle
854 $ip: The ip address of the user
856 'ExtensionTypes': called when generating the extensions credits, use this to change the tables headers
857 &$extTypes: associative array of extensions types
859 'FetchChangesList': When fetching the ChangesList derivative for
860 a particular user
861 $user: User the list is being fetched for
862 &$skin: Skin object to be used with the list
863 &$list: List object (defaults to NULL, change it to an object
864         instance and return false override the list derivative used)
866 'FileDeleteComplete': When a file is deleted
867 $file: reference to the deleted file
868 $oldimage: in case of the deletion of an old image, the name of the old file
869 $article: in case all revisions of the file are deleted a reference to the
870         article associated with the file.
871 $user: user who performed the deletion
872 $reason: reason
874 'FileUpload': When a file upload occurs
875 $file : Image object representing the file that was uploaded
876 $reupload : Boolean indicating if there was a previously another image there or not (since 1.17)
877 $hasDescription : Boolean indicating that there was already a description page and a new one from the comment wasn't created (since 1.17)
879 'FileUndeleteComplete': When a file is undeleted
880 $title: title object to the file
881 $fileVersions: array of undeleted versions. Empty if all versions were restored
882 $user: user who performed the undeletion
883 $reason: reason
885 'GetAutoPromoteGroups': When determining which autopromote groups a user
886 is entitled to be in.
887 &$user: user to promote.
888 &$promote: groups that will be added.
890 'GetBlockedStatus': after loading blocking status of an user from the database
891 $user: user (object) being checked
893 'GetCacheVaryCookies': get cookies that should vary cache options
894 $out: OutputPage object
895 &$cookies: array of cookies name, add a value to it if you want to add a cookie
896         that have to vary cache options
898 'GetCanonicalURL': modify fully-qualified URLs used for IRC and e-mail notifications
899 $title: Title object of page
900 $url: string value as output (out parameter, can modify)
901 $query: query options passed to Title::getCanonicalURL()
902 $variant: variant passed to Title::getCanonicalURL()
904 'GetDefaultSortkey': Override the default sortkey for a page.
905 $title: Title object that we need to get a sortkey for
906 &$sortkey: Sortkey to use.
908 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
909 $title: Title object of page
910 $url: string value as output (out parameter, can modify)
911 $query: query options passed to Title::getFullURL()
912 $variant: variant passed to Title::getFullURL()
914 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
915 $title: Title object of page
916 $url: string value as output (out parameter, can modify)
917 $query: query options passed to Title::getInternalURL()
918 $variant: variant passed to Title::getFullURL()
920 'GetIP': modify the ip of the current user (called only once)
921 &$ip: string holding the ip as determined so far
923 'GetLinkColours': modify the CSS class of an array of page links
924 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
925         indexed by page_id.
926 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
928 'GetLocalURL': modify local URLs as output into page links. Note that if you
929         are working with internal urls (non-interwiki) then it may be preferable
930         to work with the GetLocalURL::Internal or GetLocalURL::Article hooks as
931         GetLocalURL can be buggy for internal urls on render if you do not
932         re-implement the horrible hack that Title::getLocalURL uses
933         in your own extension.
934 $title: Title object of page
935 &$url: string value as output (out parameter, can modify)
936 $query: query options passed to Title::getLocalURL()
937 $variant: variant passed to Title::getLocalURL()
939 'GetLocalURL::Internal': modify local URLs to internal pages.
940 $title: Title object of page
941 &$url: string value as output (out parameter, can modify)
942 $query: query options passed to Title::getLocalURL()
943 $variant: variant passed to Title::getLocalURL()
945 'GetLocalURL::Article': modify local URLs specifically pointing to article paths
946         without any fancy queries or variants.
947 $title: Title object of page
948 &$url: string value as output (out parameter, can modify)
950 'GetMetadataVersion': modify the image metadata version currently in use. This is
951         used when requesting image metadata from a ForiegnApiRepo. Media handlers
952         that need to have versioned metadata should add an element to the end of
953         the version array of the form 'handler_name=version'. Most media handlers
954         won't need to do this unless they broke backwards compatibility with a
955         previous version of the media handler metadata output. 
956 &$version: Array of version strings
958 'GetPreferences': modify user preferences
959 $user: User whose preferences are being modified.
960 &$preferences: Preferences description array, to be fed to an HTMLForm object
962 'getUserPermissionsErrors': Add a permissions error when permissions errors are
963         checked for.  Use instead of userCan for most cases. Return false if the
964         user can't do it, and populate $result with the reason in the form of
965         array( messagename, param1, param2, ... ).  For consistency, error messages
966         should be plain text with no special coloring, bolding, etc. to show that
967         they're errors; presenting them properly to the user as errors is done by
968         the caller.
969 $title: Title object being checked against
970 $user : Current user object
971 $action: Action being checked
972 $result: User permissions error to add. If none, return true.
974 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
975         if expensive checks are enabled.
977 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
978         image insertion.  You can skip the default logic entirely by returning
979         false, or just modify a few things using call-by-reference.
980 &$skin: Skin object
981 &$title: Title object of the image
982 &$file: File object, or false if it doesn't exist
983 &$frameParams: Various parameters with special meanings; see documentation in
984         includes/Linker.php for Linker::makeImageLink2
985 &$handlerParams: Various parameters with special meanings; see documentation in
986         includes/Linker.php for Linker::makeImageLink2
987 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
988 &$res: Final HTML output, used if you return false
991 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
992         the image on an image page
993 $imagePage: ImagePage object ($this)
994 $output: $wgOut
996 'ImagePageAfterImageLinks': called after the image links section on an image 
997         page is built
998 $imagePage: ImagePage object ($this)
999 &$html: HTML for the hook to add
1001 'ImagePageFileHistoryLine': called when a file history line is contructed
1002 $file: the file
1003 $line: the HTML of the history line
1004 $css: the line CSS class
1006 'ImagePageFindFile': called when fetching the file associated with an image page
1007 $page: ImagePage object
1008 &$file: File object
1009 &$displayFile: displayed File object
1011 'ImagePageShowTOC': called when the file toc on an image page is generated
1012 $page: ImagePage object
1013 &$toc: Array of <li> strings
1015 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1016         using img_auth.php
1017 &$title: the Title object of the file as it would appear for the upload page
1018 &$path: the original file and path name when img_auth was invoked by the the web
1019         server
1020 &$name: the name only component of the file
1021 &$result: The location to pass back results of the hook routine (only used if
1022         failed)
1023         $result[0]=The index of the header message
1024         $result[1]=The index of the body text message
1025         $result[2 through n]=Parameters passed to body text message. Please note the
1026         header message cannot receive/use parameters.
1028 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
1029 $reader: XMLReader object
1030 $logInfo: Array of information
1031 Return false to stop further processing of the tag
1033 'ImportHandlePageXMLTag': When parsing a XML tag in a page
1034 $reader: XMLReader object
1035 $pageInfo: Array of information
1036 Return false to stop further processing of the tag
1038 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
1039 $reader: XMLReader object
1040 $revInfo: Array of information
1041 Return false to stop further processing of the tag
1043 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
1044 $reader: XMLReader object
1045 Return false to stop further processing of the tag
1047 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
1048 $reader: XMLReader object
1049 $revisionInfo: Array of information
1050 Return false to stop further processing of the tag
1052 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
1053 $title: Title object ($wgTitle)
1054 $request: WebRequest
1055 $ignoreRedirect: boolean to skip redirect check
1056 $target: Title/string of redirect target
1057 $article: Article object
1059 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1060 Return true without providing an interwiki to continue interwiki search.
1061 $prefix: interwiki prefix we are looking for.
1062 &$iwData: output array describing the interwiki with keys iw_url, iw_local, 
1063   iw_trans and optionally iw_api and iw_wikiid.
1065 'InternalParseBeforeLinks': during Parser's internalParse method before links
1066 but after noinclude/includeonly/onlyinclude and other processing.
1067 &$parser: Parser object
1068 &$text: string containing partially parsed text
1069 &$stripState: Parser's internal StripState object
1071 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
1072 $user: user (object) whose email is being invalidated
1074 'IRCLineURL': When constructing the URL to use in an IRC notification.
1075 Callee may modify $url and $query, URL will be constructed as $url . $query
1076 &$url: URL to index.php
1077 &$query: Query string
1079 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1080 $article: article (object) being checked
1082 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1083 $ip: IP being check
1084 $result: Change this value to override the result of wfIsTrustedProxy()
1086 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
1087 tance to return false if the domain name doesn't match your organization
1088 $addr: The e-mail address entered by the user
1089 &$result: Set this and return false to override the internal checks
1091 'isValidPassword': Override the result of User::isValidPassword()
1092 $password: The password entered by the user
1093 &$result: Set this and return false to override the internal checks
1094 $user: User the password is being validated for
1096 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1097 remove namespaces. Do not use this hook to add namespaces. Use 
1098 CanonicalNamespaces for that.
1099 &$namespaces: Array of namespaces indexed by their numbers
1101 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in 
1102 $wgExtensionMessagesFiles instead. 
1103 Use this to define synonyms of magic words depending of the language
1104 $magicExtensions: associative array of magic words synonyms
1105 $lang: laguage code (string)
1107 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1108 listed in $wgExtensionMessagesFiles instead.
1109 Use to define aliases of special pages names depending of the language
1110 $specialPageAliases: associative array of magic words synonyms
1111 $lang: laguage code (string)
1113 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1114 &$names: array of language code => language name
1115 $code language of the preferred translations
1117 'LinkBegin': Used when generating internal and interwiki links in
1118 Linker::link(), before processing starts.  Return false to skip default proces-
1119 sing and return $ret.  See documentation for Linker::link() for details on the
1120 expected meanings of parameters.
1121 $skin: the Skin object
1122 $target: the Title that the link is pointing to
1123 &$html: the contents that the <a> tag should have (raw HTML); null means "de-
1124         fault"
1125 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
1126         tive array form, with keys and values unescaped.  Should be merged with de-
1127         fault values, with a value of false meaning to suppress the attribute.
1128 &$query: the query string to add to the generated URL (the bit after the "?"),
1129         in associative array form, with keys and values unescaped.
1130 &$options: array of options.  Can include 'known', 'broken', 'noclasses'.
1131 &$ret: the value to return if your hook returns false.
1133 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1134 just before the function returns a value.  If you return true, an <a> element
1135 with HTML attributes $attribs and contents $html will be returned.  If you re-
1136 turn false, $ret will be returned.
1137 $skin: the Skin object
1138 $target: the Title object that the link is pointing to
1139 $options: the options.  Will always include either 'known' or 'broken', and may
1140         include 'noclasses'.
1141 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1142 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1143         ciative array form.
1144 &$ret: the value to return if your hook returns false.
1146 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1147 before the return
1148 &$url: the image url
1149 &$alt: the image's alt text
1150 &$img: the new image HTML (if returning false)
1152 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1153 before the return
1154 &$url: the link url
1155 &$text: the link text
1156 &$link: the new link HTML (if returning false)
1157 &$attribs: the attributes to be applied.
1158 $linkType: The external link type
1160 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1161 actual update
1162 &$linksUpdate: the LinksUpdate object
1164 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1165 completed
1166 &$linksUpdate: the LinksUpdate object
1168 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1169 &$linksUpdate: the LinksUpdate object
1171 'ListDefinedTags': When trying to find all defined tags.
1172 &$tags: The list of tags.
1174 'LoadExtensionSchemaUpdates': called during database installation and updates
1175 &updater: A DatabaseUpdater subclass
1177 'LocalFile::getHistory': called before file history query performed
1178 $file: the file
1179 $tables: tables
1180 $fields: select fields
1181 $conds: conditions
1182 $opts: query options
1183 $join_conds: JOIN conditions
1185 'LocalisationCacheRecache': Called when loading the localisation data into cache
1186 $cache: The LocalisationCache object
1187 $code: language code
1188 &$alldata: The localisation data from core and extensions
1190 'LoginAuthenticateAudit': a login attempt for a valid user account either
1191 succeeded or failed. No return data is accepted; this hook is for auditing only.
1192 $user: the User object being authenticated against
1193 $password: the password being submitted and found wanting
1194 $retval: a LoginForm class constant with authenticateUserData() return
1195         value (SUCCESS, WRONG_PASS, etc)
1197 'LogLine': Processes a single log entry on Special:Log
1198 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1199         logging.log_type database field.
1200 $log_action: string for the type of log action (e.g. 'delete', 'block',
1201         'create2'). Corresponds to logging.log_action database field.
1202 $title: Title object that corresponds to logging.log_namespace and
1203         logging.log_title database fields.
1204 $paramArray: Array of parameters that corresponds to logging.log_params field.
1205         Note that only $paramArray[0] appears to contain anything.
1206 &$comment: string that corresponds to logging.log_comment database field, and
1207         which is displayed in the UI.
1208 &$revert: string that is displayed in the UI, similar to $comment.
1209 $time: timestamp of the log entry (added in 1.12)
1211 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance script
1212 $refreshLinks: RefreshLinks object
1214 'MagicWordMagicWords': When defining new magic word.
1215 DEPRECATED: use $magicWords in a file listed in 
1216 $wgExtensionMessagesFiles instead.
1217 $magicWords: array of strings
1219 'MagicWordwgVariableIDs': When definig new magic words IDs.
1220 $variableIDs: array of strings
1222 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1223 is executed. Ideally, this hook should only be used to add variables that
1224 depend on the current page/request; static configuration should be added
1225 through ResourceLoaderGetConfigVars instead.
1226 &$vars: variable (or multiple variables) to be added into the output
1227         of Skin::makeVariablesScript
1228 &$out: The OutputPage which called the hook,
1229     can be used to get the real title
1231 'MarkPatrolled': before an edit is marked patrolled
1232 $rcid: ID of the revision to be marked patrolled
1233 $user: the user (object) marking the revision as patrolled
1234 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1235         needs to be a sysop in order to mark an edit patrolled
1237 'MarkPatrolledComplete': after an edit is marked patrolled
1238 $rcid: ID of the revision marked as patrolled
1239 $user: user (object) who marked the edit patrolled
1240 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1241         must be a sysop to patrol the edit
1243 'MediaWikiPerformAction': Override MediaWiki::performAction().
1244 Use this to do something completely different, after the basic
1245 globals have been set up, but before ordinary actions take place.
1246 $output: $wgOut
1247 $article: $wgArticle
1248 $title: $wgTitle
1249 $user: $wgUser
1250 $request: $wgRequest
1251 $mediaWiki: The $mediawiki object
1253 'MessagesPreLoad': When loading a message from the database
1254 $title: title of the message (string)
1255 $message: value (string), change it to the message you want to define
1257 'MessageCacheReplace': When a message page is changed.
1258 Useful for updating caches.
1259 $title: name of the page changed.
1260 $text: new contents of the page.
1262 'ModifyExportQuery': Modify the query used by the exporter.
1263 $db: The database object to be queried.
1264 &$tables: Tables in the query.
1265 &$conds: Conditions in the query.
1266 &$opts: Options for the query.
1267 &$join_conds: Join conditions for the query.
1269 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1270 been rendered (useful for adding more)
1271 Note: this is only run for the Monobook skin. This hook is deprecated and
1272 may be removed in the future. To add items to the toolbox you should use 
1273 the SkinTemplateToolboxEnd hook instead, which works for all 
1274 "SkinTemplate"-type skins.
1275 $tools: array of tools
1277 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1278 and returning it for the skin to output. You can add items to the toolbox while
1279 still letting the skin make final decisions on skin-specific markup conventions
1280 using this hook.
1281 &$sk: The BaseTemplate base skin template
1282 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1283         BaseTemplate::makeListItem for details on the format of individual
1284         items inside of this array
1286 'NewRevisionFromEditComplete': called when a revision was inserted
1287 due to an edit
1288 $article: the WikiPage edited
1289 $rev: the new revision
1290 $baseID: the revision ID this was based off, if any
1291 $user: the editing user
1293 'NormalizeMessageKey': Called before the software gets the text of a message
1294 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1295 displayed
1296 &$key: the message being looked up. Change this to something else to change
1297         what message gets displayed (string)
1298 &$useDB: whether or not to look up the message in the database (bool)
1299 &$langCode: the language code to get the message for (string) - or -
1300         whether to use the content language (true) or site language (false) (bool)
1301 &$transform: whether or not to expand variables and templates
1302         in the message (bool)
1304 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1305 &$changeslist: The OldChangesList instance.
1306 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1307 &$rc: The RecentChange object.
1309 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1310 Hooks can alter or append to the array of URLs for search & suggestion formats.
1311 &$urls: array of associative arrays with Url element attributes
1313 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1314         users and/or IP addresses too
1315 $otherBlockLink: An array with links to other block logs
1316 $ip: The requested IP address or username
1318 'OutputPageBeforeHTML': a page has been processed by the parser and
1319 the resulting HTML is about to be displayed.
1320 $parserOutput: the parserOutput (object) that corresponds to the page
1321 $text: the text that will be displayed, in HTML (string)
1323 'OutputPageBodyAttributes': called when OutputPage::headElement is creating the body
1324 tag to allow for extensions to add attributes to the body of the page they might
1325 need. Or to allow building extensions to add body classes that aren't of high
1326 enough demand to be included in core.
1327 $out: The OutputPage which called the hook, can be used to get the real title
1328 $sk: The Skin that called OutputPage::headElement
1329 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1331 'OutputPageCheckLastModified': when checking if the page has been modified
1332 since the last visit
1333 &$modifiedTimes: array of timestamps.
1334         The following keys are set: page, user, epoch
1336 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1337 $out: OutputPage instance (object)
1338 $parserOutput: parserOutput instance being added in $out
1340 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1341 categories. Implementations should return false if they generate the category
1342 links, so the default link generation is skipped.
1343 $out: OutputPage instance (object)
1344 $categories: associative array, keys are category names, values are category
1345         types ("normal" or "hidden")
1346 $links: array, intended to hold the result. Must be an associative array with
1347         category types as keys and arrays of HTML links as values.
1349 'PageContentLanguage': allows changing the language in which the content of
1350 a page is written. Defaults to the wiki content language ($wgContLang).
1351 $title: Title object
1352 &$pageLang: the page content language (either an object or a language code)
1353 $wgLang: the user language
1355 'PageHistoryBeforeList': When a history page list is about to be constructed.
1356 $article: the article that the history is loading for
1358 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1359 $row: the revision row for this line
1360 $s: the string representing this parsed line
1361 $classes: array containing the <li> element classes
1363 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1364 is constructed
1365 $pager: the pager
1366 $queryInfo: the query parameters
1368 'PageRenderingHash': alter the parser cache option hash key
1369 A parser extension which depends on user options should install
1370 this hook and append its values to the key.
1371 $hash: reference to a hash key string which can be modified
1373 'ParserAfterStrip': Same as ParserBeforeStrip
1375 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1376 $parser: Parser object being used
1377 $text: text that'll be returned
1379 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1380 $parser: Parser object
1381 $text: text to parse
1382 $stripState: StripState instance being used
1384 'ParserBeforeStrip': Called at start of parsing time
1385 (no more strip, deprecated ?)
1386 $parser: parser object
1387 $text: text being parsed
1388 $stripState: stripState used (object)
1390 'ParserBeforeTidy': called before tidy and custom tags replacements
1391 $parser: Parser object being used
1392 $text: actual text
1394 'ParserClearState': called at the end of Parser::clearState()
1395 $parser: Parser object being cleared
1397 'ParserFirstCallInit': called when the parser initialises for the first time
1398 &$parser: Parser object being cleared
1400 'ParserGetVariableValueSwitch': called when the parser need the value of a
1401 custom magic word
1402 $parser: Parser object
1403 $varCache: array to store the value in case of multiples calls of the
1404         same magic word
1405 $index: index (string) of the magic
1406 $ret: value of the magic word (the hook should set it)
1407 $frame: PPFrame object to use for expanding any template variables
1409 'ParserGetVariableValueTs': use this to change the value of the time for the
1410 {{LOCAL...}} magic word
1411 $parser: Parser object
1412 $time: actual time (timestamp)
1414 'ParserGetVariableValueVarCache': use this to change the value of the
1415 variable cache or return false to not use it
1416 $parser: Parser object
1417 $varCache: varaiable cache (array)
1419 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1420 include comments about size of the text parsed
1421 $parser: Parser object
1422 $limitReport: text that will be included (without comment tags)
1424 'ParserMakeImageParams': Called before the parser make an image link, use this
1425 to modify the parameters of the image.
1426 $title: title object representing the file
1427 $file: file object that will be used to create the image
1428 &$params: 2-D array of parameters
1430 'ParserSectionCreate': Called each time the parser creates a document section
1431 from wikitext.  Use this to apply per-section modifications to HTML (like
1432 wrapping the section in a DIV).  Caveat: DIVs are valid wikitext, and a DIV
1433 can begin in one section and end in another.  Make sure your code can handle
1434 that case gracefully.  See the EditSectionClearerLink extension for an
1435 example.
1436 $parser: the calling Parser instance
1437 $section: the section number, zero-based, but section 0 is usually empty
1438 &$sectionContent: ref to the content of the section. modify this.
1439 $showEditLinks: boolean describing whether this section has an edit link
1441 'ParserTestParser': called when creating a new instance of Parser in
1442 maintenance/parserTests.inc
1443 $parser: Parser object created
1445 'ParserTestTables': alter the list of tables to duplicate when parser tests
1446 are run. Use when page save hooks require the presence of custom tables
1447 to ensure that tests continue to run properly.
1448 &$tables: array of table names
1450 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1451 my talk page, my contributions" etc).
1453 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1454 &$title: Title object representing the current page
1456 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1457 &$user : User performing the action
1458 $action : Action being performed
1459 &$result : Whether or not the action should be prevented
1460 Change $result and return false to give a definitive answer, otherwise
1461 the built-in rate limiting checks are used, if enabled.
1463 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1464 AJAX search suggestions. Put results into &$results outparam and return false.
1465 $ns : array of int namespace keys to search in
1466 $search : search term (not guaranteed to be conveniently normalized)
1467 $limit : maximum number of results to return
1468 &$results : out param: array of page names (strings)
1470 'PrefsEmailAudit': called when user changes his email address
1471 $user: User (object) changing his email address
1472 $oldaddr: old email address (string)
1473 $newaddr: new email address (string)
1475 'PrefsPasswordAudit': called when user changes his password
1476 $user: User (object) changing his passoword
1477 $newPass: new password
1478 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1480 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1481 $article: the title being (un)protected
1482 $output: a string of the form HTML so far
1484 'ProtectionForm::save': called when a protection form is submitted
1485 $article: the title being (un)protected
1486 $errorMsg: an html message string of an error
1488 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1489 $article: the page the form is shown for
1490 $out: OutputPage object
1492 'ResourceLoaderRegisterModules': Right before modules information is required, such as when responding to a resource
1493 loader request or generating HTML output.
1494 &$resourceLoader: ResourceLoader object
1496 'ResourceLoaderGetStartupModules': Run once the startup module is being generated. This allows you
1497 to add modules to the startup module. This hook should be used sparingly since any module added here
1498 will be loaded on all pages. This hook is useful if you want to make code available to module loader 
1499 scripts. 
1501 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1502 &$obj: RawPage object
1503 &$text: The text that's going to be the output
1505 'RecentChange_save': called at the end of RecentChange::save()
1506 $recentChange: RecentChange object
1508 'ResourceLoaderGetConfigVars': called at the end of
1509 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1510 configuration variables to JavaScript. Things that depend on the current
1511 page/request state must be added through MakeGlobalVariablesScript instead.
1512 &$vars: array( variable name => value )
1514 'RevisionInsertComplete': called after a revision is inserted into the DB
1515 &$revision: the Revision
1516 $data: the data stored in old_text.  The meaning depends on $flags: if external
1517   is set, it's the URL of the revision text in external storage; otherwise,
1518   it's the revision text itself.  In either case, if gzip is set, the revision
1519   text is gzipped.
1520 $flags: a comma-delimited list of strings representing the options used.  May
1521   include: utf8 (this will always be set for new revisions); gzip; external.
1523 'SearchUpdate': Prior to search update completion
1524 $id : Page id
1525 $namespace : Page namespace
1526 $title : Page title
1527 $text : Current text being indexed
1529 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1530 $allSearchTerms : Array of the search terms in all content languages
1531 &$titleResult : Outparam; the value to return. A Title object or null.
1533 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1534 $term : Search term string
1535 &$title : Outparam; set to $title object and return false for a match
1537 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1538 $term : Search term string
1539 &$title : Current Title object that is being returned (null if none found).
1541 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1542 $searchEngine : The SearchEngine object. Users of this hooks will be interested 
1543 in the $searchEngine->namespaces array.
1544 $query : Original query.
1545 &$parsed : Resultant query with the prefixes stripped.
1547 'SearchableNamespaces': An option to modify which namespaces are searchable.
1548 &$arr : Array of namespaces ($nsId => $name) which will be used.
1550 'SetupAfterCache': Called in Setup.php, after cache objects are set
1552 'ShowMissingArticle': Called when generating the output for a non-existent page
1553 $article: The article object corresponding to the page
1555 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1556 $text: Text being shown
1557 $title: Title of the custom script/stylesheet page
1558 $output: Current OutputPage object
1560 'ShowSearchHitTitle': Customise display of search hit title/link.
1561 &$title: Title to link to
1562 &$text: Text to use for the link
1563 $result: The search result
1564 $terms: The search terms entered
1565 $page: The SpecialSearch object.
1567 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1568 &$siteNotice: HTML returned as the sitenotice
1569 $skin: Skin object
1570 Return true to allow the normal method of notice selection/rendering to work,
1571 or change the value of $siteNotice and return false to alter it.
1573 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1574 &$siteNotice: HTML sitenotice
1575 $skin: Skin object
1576 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1578 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1579 $skin: Skin object
1580 &$text: bottomScripts Text
1581 Append to $text to add additional text/scripts after the stock bottom scripts.
1583 'SkinAfterContent': Allows extensions to add text after the page content and
1584 article metadata.
1585 &$data: (string) Text to be printed out directly (without parsing)
1586 $skin: Skin object
1587 This hook should work in all skins. Just set the &$data variable to the text
1588 you're going to add.
1590 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1591 $skin: Skin object
1592 &$bar: Sidebar contents
1593 Modify $bar to add or modify sidebar portlets.
1595 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1596 $title: displayed page title
1597 $type: 'normal' or 'history' for old/diff views
1598 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1599 &$link: overridable HTML link to be passed into the message as $1
1600 &$forContent: overridable flag if copyright footer is shown in content language. 
1602 'SkinGetPoweredBy'
1603 &$text: additional 'powered by' icons in HTML.
1604 Note: Modern skin does not use the MediaWiki icon but plain text instead
1605 $skin: Skin object
1607 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1608 &$subpages: Subpage links HTML
1609 $skin: Skin object
1610 $out: OutputPage object
1611 If false is returned $subpages will be used instead of the HTML
1612 subPageSubtitle() generates.
1613 If true is returned, $subpages will be ignored and the rest of
1614 subPageSubtitle() will run.
1616 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1617 "permanent link" tab
1618 $sktemplate: SkinTemplate object
1619 $nav_urls: array of tabs
1621 Alter the structured navigation links in SkinTemplates, there are three of these hooks called in different spots.
1622 'SkinTemplateNavigation': Called on content pages after the tabs have been added but before before variants have been added
1623 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special tab is added but before variants have been added
1624 'SkinTemplateNavigation::Universal': Called on both content and special pages after variants have been added
1625 &$sktemplate: SkinTemplate object
1626 &$links: Structured navigation links
1627 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1629 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1630 starts page output
1631 &$sktemplate: SkinTemplate object
1632 &$tpl: Template engine object
1634 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1635 $sktemplate: SkinTemplate object
1636 $res: set to true to prevent active tabs
1638 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1639 You can either create your own array, or alter the parameters for
1640 the normal one.
1641 &$sktemplate: The SkinTemplate instance.
1642 $title: Title instance for the page.
1643 $message: Visible label of tab.
1644 $selected: Whether this is a selected tab.
1645 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1646 &$classes: Array of CSS classes to apply.
1647 &$query: Query string to add to link.
1648 &$text: Link text.
1649 &$result: Complete assoc. array if you want to return true.
1651 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1652 been rendered (useful for adding more)
1653 $sk: The QuickTemplate based skin template running the hook.
1655 'SoftwareInfo': Called by Special:Version for returning information about
1656 the software
1657 $software: The array of software in format 'name' => 'version'.
1658         See SpecialVersion::softwareInformation()
1660 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1661 $id: User identifier
1663 'SpecialListusersDefaultQuery': called right before the end of
1664 UsersPager::getDefaultQuery()
1665 $pager: The UsersPager instance
1666 $query: The query array to be returned
1668 'SpecialListusersFormatRow': called right before the end of
1669 UsersPager::formatRow()
1670 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1671 $row: Database row object
1673 'SpecialListusersHeader': called before closing the <fieldset> in
1674 UsersPager::getPageHeader()
1675 $pager: The UsersPager instance
1676 $out: The header HTML
1678 'SpecialListusersHeaderForm': called before adding the submit button in
1679 UsersPager::getPageHeader()
1680 $pager: The UsersPager instance
1681 $out: The header HTML
1683 'SpecialListusersQueryInfo': called right before the end of
1684 UsersPager::getQueryInfo()
1685 $pager: The UsersPager instance
1686 $query: The query array to be returned
1688 'SpecialMovepageAfterMove': called after moving a page
1689 $movePage: MovePageForm object
1690 $oldTitle: old title (object)
1691 $newTitle: new title (object)
1693 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1694 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1695 $opts: FormOptions object containing special page options
1696 &$conds: array of WHERE conditionals for query
1697 &tables: array of tables to be queried
1698 &$fields: array of columns to select
1699 &$join_conds: join conditions for the tables
1701 'SpecialNewPagesFilters': called after building form options at NewPages
1702 $special: the special page object
1703 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1704 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1706 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1707 hook to remove a core special page
1708 $list: list (array) of core special pages
1710 'SpecialPasswordResetOnSubmit': when executing a form submission on Special:PasswordReset
1711 $users: array of User objects
1712 $data: array of data submitted by the user
1713 &$error: string, error code (message name) used to describe to error (out paramater).
1714         The hook needs to return false when setting this, otherwise it will have no effect.
1716 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1717 use this to change some selection criteria or substitute a different title
1718 &$randstr: The random number from wfRandom()
1719 &$isRedir: Boolean, whether to select a redirect or non-redirect 
1720 &$namespaces: An array of namespace indexes to get the title from
1721 &$extra: An array of extra SQL statements 
1722 &$title: If the hook returns false, a Title object to use instead of the
1723 result from the normal query
1725 'SpecialRecentChangesFilters': called after building form options at RecentChanges
1726 $special: the special page object
1727 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1728 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1730 'SpecialRecentChangesPanel': called when building form options in
1731 SpecialRecentChanges
1732 &$extraOpts: array of added items, to which can be added
1733 $opts: FormOptions for this request
1735 'SpecialRecentChangesQuery': called when building sql query for
1736 SpecialRecentChanges and SpecialRecentChangesLinked
1737 &$conds: array of WHERE conditionals for query
1738 &$tables: array of tables to be queried
1739 &$join_conds: join conditions for the tables
1740 $opts: FormOptions for this request
1741 &$query_options: array of options for the database request
1742 &$select: Array of columns to select
1744 'SpecialSearchGo': called when user clicked the "Go"
1745 &$title: title object generated from the text entered by the user
1746 &$term: the search term entered by the user
1748 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1749 target doesn't exist
1750 &$title: title object generated from the text entered by the user
1752 'SpecialSearchProfiles': allows modification of search profiles
1753 &$profiles: profiles, which can be modified.
1755 'SpecialSearchProfileForm': allows modification of search profile forms
1756 $search: special page object
1757 &$form: String: form html
1758 $profile: String: current search profile
1759 $term: String: search term
1760 $opts: Array: key => value of hidden options for inclusion in custom forms
1762 'SpecialSearchSetupEngine': allows passing custom data to search engine
1763 $search: special page object
1764 $profile: String: current search profile
1765 $engine: the search engine
1767 'SpecialSearchResults': called before search result display when there
1768 are matches
1769 $term: string of search term
1770 &$titleMatches: empty or SearchResultSet object
1771 &$textMatches: empty or SearchResultSet object
1773 'SpecialSearchNoResults': called before search result display when there are
1774 no matches
1775 $term: string of search term
1777 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1778 &$extraStats: Array to save the new stats 
1779               ( $extraStats['<name of statistic>'] => <value>; )
1781 'SpecialUploadComplete': Called after successfully uploading a file from 
1782 Special:Upload
1783 $form: The SpecialUpload object
1785 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1786 use this to change the tables headers
1787 $extTypes: associative array of extensions types
1789 'SpecialWatchlistFilters': called after building form options at Watchlist
1790 $special: the special page object
1791 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1792 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1794 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1795 &$conds: array of WHERE conditionals for query
1796 &$tables: array of tables to be queried
1797 &$join_conds: join conditions for the tables
1798 &$fields: array of query fields
1800 'TitleArrayFromResult': called when creating an TitleArray object from a
1801 database result
1802 &$titleArray: set this to an object to override the default object returned
1803 $res: database result used to create the object
1805 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1806   that can be applied.
1807 $title: The title in question.
1808 &$types: The types of protection available.
1810 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page
1811 $title: Title object that is being checked
1812 $result: Boolean; whether MediaWiki currently thinks this is a CSS/JS page. Hooks may change this value to override the return value of Title::isCssOrJsPage()
1814 'TitleIsMovable': Called when determining if it is possible to move a page.
1815 Note that this hook is not called for interwiki pages or pages in immovable namespaces: for these, isMovable() always returns false.
1816 $title: Title object that is being checked
1817 $result: Boolean; whether MediaWiki currently thinks this page is movable. Hooks may change this value to override the return value of Title::isMovable()
1819 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
1820 be handled by seperate handler (via ArticleViewCustom)
1821 $title: Title object that is being checked
1822 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page. Hooks may change this value to override the return value of Title::isWikitextPage()
1824 'TitleMoveComplete': after moving an article (title)
1825 $old: old title
1826 $nt: new title
1827 $user: user who did the move
1828 $pageid: database ID of the page that's been moved
1829 $redirid: database ID of the created redirect
1831 'UndeleteForm::showHistory': called in UndeleteForm::showHistory, after a
1832 PageArchive object has been created but before any further processing is done.
1833 &$archive: PageArchive object
1834 $title: Title object of the page that we're viewing
1836 'UndeleteForm::showRevision': called in UndeleteForm::showRevision, after a
1837 PageArchive object has been created but before any further processing is done.
1838 &$archive: PageArchive object
1839 $title: Title object of the page that we're viewing
1841 'UndeleteForm::undelete': called un UndeleteForm::undelete, after checking that
1842 the site is not in read-only mode, that the Title object is not null and after
1843 a PageArchive object has been constructed but before performing any further
1844 processing.
1845 &$archive: PageArchive object
1846 $title: Title object of the page that we're about to undelete
1848 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1849 $title: title object related to the revision
1850 $rev: revision (object) that will be viewed
1852 'UnknownAction': An unknown "action" has occured (useful for defining
1853                  your own actions)
1854 $action: action name
1855 $article: article "acted on"
1857 'UnitTestsList': Called when building a list of files with PHPUnit tests
1858 &$files: list of files
1860 'UnwatchArticle': before a watch is removed from an article
1861 $user: user watching
1862 $article: article object to be removed
1864 'UnwatchArticle': after a watch is removed from an article
1865 $user: user that was watching
1866 $article: article object removed
1868 'UnwatchArticleComplete': after a watch is removed from an article
1869 $user: user that watched
1870 $article: article object that was watched
1872 'UploadForm:initial': before the upload form is generated
1873 $form: UploadForm object
1874 You might set the member-variables $uploadFormTextTop and
1875 $uploadFormTextAfterSummary to inject text (HTML) either before
1876 or after the editform.
1878 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1879 $form: UploadForm object
1880 Lets you poke at member variables like $mUploadDescription before the
1881 file is saved.
1882 Do not use this hook to break upload processing. This will return the user to
1883 a blank form with no error message; use UploadVerification and 
1884 UploadVerifyFile instead
1886 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1887 $type: (string) the requested upload type
1888 &$className: the class name of the Upload instance to be created
1890 'UploadComplete': when Upload completes an upload
1891 &$upload: an UploadBase child instance
1893 'UploadFormInitDescriptor': after the descriptor for the upload form as been 
1894         assembled
1895 $descriptor: (array) the HTMLForm descriptor
1897 'UploadFormSourceDescriptors': after the standard source inputs have been 
1898 added to the descriptor
1899 $descriptor: (array) the HTMLForm descriptor
1901 'UploadVerification': additional chances to reject an uploaded file. Consider 
1902                       using UploadVerifyFile instead.
1903 string $saveName: destination file name
1904 string $tempName: filesystem path to the temporary file for checks
1905 string &$error: output: message key for message to show if upload canceled 
1906         by returning false. May also be an array, where the first element
1907         is the message key and the remaining elements are used as parameters to
1908         the message.
1910 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
1911                     in most cases over UploadVerification.
1912 object $upload: an instance of UploadBase, with all info about the upload
1913 string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers 
1914         will typically only apply for specific mime types.
1915 object &$error: output: true if the file is valid. Otherwise, an indexed array
1916         representing the problem with the file, where the first element
1917         is the message key and the remaining elements are used as parameters to
1918         the message.
1920 'UploadComplete': Upon completion of a file upload
1921 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1922         $uploadBase->getLocalFile().
1924 'User::mailPasswordInternal': before creation and mailing of a user's new
1925 temporary password
1926 $user: the user who sent the message out
1927 $ip: IP of the user who sent the message out
1928 $u: the account whose new password will be set
1930 'UserAddGroup': called when adding a group; return false to override
1931 stock group addition.
1932 $user: the user object that is to have a group added
1933 &$group: the group to add, can be modified
1935 'UserArrayFromResult': called when creating an UserArray object from a
1936 database result
1937 &$userArray: set this to an object to override the default object returned
1938 $res: database result used to create the object
1940 'userCan': To interrupt/advise the "user can do X to Y article" check.
1941 If you want to display an error message, try getUserPermissionsErrors.
1942 $title: Title object being checked against
1943 $user : Current user object
1944 $action: Action being checked
1945 $result: Pointer to result returned if hook returns false. If null is returned,
1946         userCan checks are continued by internal code.
1948 'UserCanSendEmail': To override User::canSendEmail() permission check
1949 $user: User (object) whose permission is being checked
1950 &$canSend: bool set on input, can override on output
1952 'UserClearNewTalkNotification': called when clearing the
1953 "You have new messages!" message, return false to not delete it
1954 $user: User (object) that'll clear the message
1956 'UserComparePasswords': called when checking passwords, return false to
1957 override the default password checks
1958 &$hash: String of the password hash (from the database)
1959 &$password: String of the plaintext password the user entered
1960 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1961         supplied
1962 &$result: If the hook returns false, this Boolean value will be checked to
1963         determine if the password was valid
1965 'UserCreateForm': change to manipulate the login form
1966 $template: SimpleTemplate instance for the form
1968 'UserCryptPassword': called when hashing a password, return false to implement
1969 your own hashing method
1970 &$password: String of the plaintext password to encrypt
1971 &$salt: String of the password salt or Boolean false if no salt is provided
1972 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1973         hashing method
1974 &$hash: If the hook returns false, this String will be used as the hash
1976 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1977 $user: User to get groups for
1978 &$groups: Current effective groups
1980 'UserGetAllRights': after calculating a list of all available rights
1981 &$rights: Array of rights, which may be added to.
1983 'UserGetEmail': called when getting an user email address
1984 $user: User object
1985 &$email: email, change this to override local email
1987 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1988 email authentification
1989 $user: User object
1990 &$timestamp: timestamp, change this to override local email authentification
1991         timestamp
1993 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1994 &$groups: List of implicit (automatically-assigned) groups
1996 'UserGetLanguageObject': Called when getting user's interface language object
1997 $user: User object
1998 &$code: Langauge code that will be used to create the object
2000 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
2001 &$reservedUsernames: $wgReservedUsernames
2003 'UserGetRights': Called in User::getRights()
2004 $user: User to get rights for
2005 &$rights: Current rights
2007 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
2008         exemptions).
2009 $user: User in question
2010 $title: Title of the page in question
2011 &$blocked: Out-param, whether or not the user is blocked from that page.
2012 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
2013                   own user talk pages.
2015 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2016 &$user: User object
2017 $ip: User's IP address
2018 &$blocked: Whether the user is blocked, to be modified by the hook
2020 'UserLoadAfterLoadFromSession': called to authenticate users on
2021 external/environmental means; occurs after session is loaded
2022 $user: user object being loaded
2024 'UserLoadDefaults': called when loading a default user
2025 $user: user object
2026 $name: user name
2028 'UserLoadFromDatabase': called when loading a user from the database
2029 $user: user object
2030 &$s: database query object
2032 'UserLoadFromSession': called to authenticate users on external/environmental
2033 means; occurs before session is loaded
2034 $user: user object being loaded
2035 &$result: set this to a boolean value to abort the normal authentification
2036         process
2038 'UserLoadOptions': when user options/preferences are being loaded from
2039 the database.
2040 $user: User object
2041 &$options: Options, can be modified.
2043 'UserLoginComplete': after a user has logged in
2044 $user: the user object that was created on login
2045 $inject_html: Any HTML to inject after the "logged in" message.
2047 'UserLoginForm': change to manipulate the login form
2048 $template: SimpleTemplate instance for the form
2050 'UserLogout': before a user logs out
2051 $user: the user object that is about to be logged out
2053 'UserLogoutComplete': after a user has logged out
2054 $user: the user object _after_ logout (won't have name, ID, etc.)
2055 $inject_html: Any HTML to inject after the "logged out" message.
2056 $oldName: name of the user before logout (string)
2058 'UserRemoveGroup': called when removing a group; return false to override
2059 stock group removal.
2060 $user: the user object that is to have a group removed
2061 &$group: the group to be removed, can be modified
2063 'UserRights': After a user's group memberships are changed
2064 $user  : User object that was changed
2065 $add   : Array of strings corresponding to groups added
2066 $remove: Array of strings corresponding to groups removed
2068 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
2069 message(s)
2070 $user: user retrieving new talks messages
2071 $talks: array of new talks page(s)
2073 'UserSaveSettings': called when saving user settings
2074 $user: User object
2076 'UserSaveOptions': Called just before saving user preferences/options.
2077 $user: User object
2078 &$options: Options, modifiable
2080 'UserSetCookies': called when setting user cookies
2081 $user: User object
2082 &$session: session array, will be added to $_SESSION
2083 &$cookies: cookies array mapping cookie name to its value
2085 'UserSetEmail': called when changing user email address
2086 $user: User object
2087 &$email: new email, change this to override new email address
2089 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
2090 of email authentification
2091 $user: User object
2092 &$timestamp: new timestamp, change this to override local email
2093 authentification timestamp
2095 'WantedPages::getQueryInfo': called in WantedPagesPage::getQueryInfo(), can be
2096 used to alter the SQL query which gets the list of wanted pages
2097 &$wantedPages: WantedPagesPage object
2098 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2100 'WatchArticle': before a watch is added to an article
2101 $user: user that will watch
2102 $article: article object to be watched
2104 'WatchArticleComplete': after a watch is added to an article
2105 $user: user that watched
2106 $article: article object watched
2108 'WatchlistEditorBuildRemoveLine': when building remove lines in
2109         Special:Watchlist/edit
2110 &$tools: array of extra links
2111 $title: Title object
2112 $redirect: whether the page is a redirect
2113 $skin: Skin object
2115 'WebRequestGetPathInfoRequestURI': while extracting path info from REQUEST_URI.
2116         Allows an extension to extend the extraction of titles from paths.
2117         Implementing hooks should follow the pattern used in core:
2118         * Use the `$matches = WebRequest::extractTitle` pattern
2119         * Ensure that you test `if ( !$matches ) {` before you try extracting a title
2120           from the path so that you don't override an already found match.
2121 $path: The request path to extract a title from.
2122 &$matches: The array to apply matches to.
2124 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2125 dumps
2126 One, and only one hook should set this, and return false.
2127 &$tables: Database tables to use in the SELECT query
2128 &$opts: Options to use for the query
2129 &$join: Join conditions
2131 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
2132 query pages to be updated with maintenance/updateSpecialPages.php
2133 $query: $wgQueryPages itself
2135 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
2136  metadata to be added.
2137 $obj: The XmlDumpWriter object.
2138 &$out: The output string.
2139 $row: The database row for the page.
2140 $title: The title of the page.
2142 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
2143  metadata.
2144 $obj: The XmlDumpWriter object.
2145 &$out: The text being output.
2146 $row: The database row for the revision.
2147 $text: The revision text.
2149 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used to add
2150         additional tags to extract.
2151 &$items: Array containing information on which items to extract. See XMPInfo for details on the format.
2153 'XMPGetResults': Called just before returning the results array of parsing xmp data. Can be
2154         used to post-process the results.
2155 &$data: Array of metadata sections (such as $data['xmp-general']) each section is an array of
2156         metadata tags returned (each tag is either a value, or an array of values).
2158 More hooks might be available but undocumented, you can execute
2159 ./maintenance/findhooks.php to find hidden one.