Merge "add SpecialUndeleteLogEntry hook"
[lhc/web/wiklou.git] / docs / hooks.txt
1 hooks.txt
2
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.
5
6 ==Glossary==
7
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'.
15
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.
19
20 hook function
21 The function part of a hook.
22
23 ==Rationale==
24
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.
31
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):
36
37 function showAnArticle($article) {
38 global $wgReverseTitle, $wgCapitalizeTitle;
39
40 if ($wgReverseTitle) {
41 wfReverseTitle($article);
42 }
43
44 if ($wgCapitalizeTitle) {
45 wfCapitalizeTitle($article);
46 }
47
48 # code to actually show the article goes here
49 }
50
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:
54
55 function showAnArticle($article) {
56 global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
57
58 if ($wgReverseTitle) {
59 wfReverseTitle($article);
60 }
61
62 if ($wgCapitalizeTitle) {
63 wfCapitalizeTitle($article);
64 }
65
66 # code to actually show the article goes here
67
68 if ($wgNotifyArticle) {
69 wfNotifyArticleShow($article));
70 }
71 }
72
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:
75
76 function showAnArticle($article) {
77
78 if (wfRunHooks('ArticleShow', array(&$article))) {
79
80 # code to actually show the article goes here
81
82 wfRunHooks('ArticleShowComplete', array(&$article));
83 }
84 }
85
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.
89
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:
95
96 function reverseArticleTitle($article) {
97 # ...
98 }
99
100 function reverseForExport($article) {
101 # ...
102 }
103
104 The setup function for the extension just has to add its hook functions to the
105 appropriate events:
106
107 setupTitleReversingExtension() {
108 global $wgHooks;
109
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
113 }
114
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.
118
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:
122
123 require_once('extensions/ReverseTitle.php');
124
125 ...to their LocalSettings.php file; those of us who don't want or need it can
126 just leave it out.
127
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.
130
131 ==Writing hooks==
132
133 A hook is a chunk of code run at some particular event. It consists of:
134
135 * a function with some optional accompanying data, or
136 * an object with a method and some optional accompanying data.
137
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:
140
141 $wgHooks['EventName'][] = 'someFunction'; # function, no data
142 $wgHooks['EventName'][] = array('someFunction', $someData);
143 $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
144
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
149
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:
153
154 # function, no data
155 someFunction($param1, $param2)
156 # function with data
157 someFunction($someData, $param1, $param2)
158
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)
165
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.
169
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
172
173 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
174 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
175
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
178
179 Hooks can return three possible values:
180
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
186
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:
190
191 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
192
193 function ldapLogin($username, $password) {
194 # log user into LDAP
195 return false;
196 }
197
198 Returning false makes less sense for events where the action is complete, and
199 will normally be ignored.
200
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.
204
205 ==Using hooks==
206
207 A calling function or method uses the wfRunHooks() function to run the hooks
208 related to a particular event, like so:
209
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 }
220
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.
225
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.
231
232 ==Events and parameters==
233
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.
236
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
240
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.
244
245 'AbortDiffCache': Can be used to cancel the caching of a diff
246 &$diffEngine: DifferenceEngine object
247
248 'AbortEmailNotification': Can be used to cancel email notifications for an edit.
249 $editor: The User who made the change.
250 $title: The Title of the page that was edited.
251
252 'AbortLogin': Return false to cancel account login.
253 $user: the User object being authenticated against
254 $password: the password being submitted, not yet checked for validity
255 &$retval: a LoginForm class constant to return from authenticateUserData();
256 default is LoginForm::ABORTED. Note that the client may be using
257 a machine API rather than the HTML user interface.
258 &$msg: the message identifier for abort reason (new in 1.18, not available before 1.18)
259
260 'AbortMove': allows to abort moving an article (title)
261 $old: old title
262 $nt: new title
263 $user: user who is doing the move
264 $err: error message
265 $reason: the reason for the move (added in 1.13)
266
267 'AbortNewAccount': Return false to cancel explicit account creation.
268 $user: the User object about to be created (read-only, incomplete)
269 &$msg: out parameter: HTML to display on abort
270
271 'ActionBeforeFormDisplay': before executing the HTMLForm object
272 $name: name of the action
273 &$form: HTMLForm object
274 $article: Article object
275
276 'ActionModifyFormFields': before creating an HTMLForm object for a page action;
277 allows to change the fields on the form that will be generated
278 $name: name of the action
279 &$fields: HTMLForm descriptor array
280 $article: Article object
281
282 'AddNewAccount': after a user account is created
283 $user: the User object that was created. (Parameter added in 1.7)
284 $byEmail: true when account was created "by email" (added in 1.12)
285
286 'AfterFinalPageOutput': At the end of OutputPage::output() but before
287 final ob_end_flush() which will send the buffered output to the client.
288 This allows for last-minute modification of the output within the buffer
289 by using ob_get_clean().
290
291 'AfterImportPage': When a page import is completed
292 $title: Title under which the revisions were imported
293 $origTitle: Title provided by the XML file
294 $revCount: Number of revisions in the XML file
295 $sRevCount: Number of sucessfully imported revisions
296 $pageInfo: associative array of page information
297
298 'AfterFinalPageOutput': Nearly at the end of OutputPage::output() but
299 before OutputPage::sendCacheControl() and final ob_end_flush() which
300 will send the buffered output to the client. This allows for last-minute
301 modification of the output within the buffer by using ob_get_clean().
302 $output: The OutputPage object where output() was called
303
304 'AjaxAddScript': Called in output page just before the initialisation
305 of the javascript ajax engine. The hook is only called when ajax
306 is enabled ( $wgUseAjax = true; ).
307
308 'AlternateEdit': before checking if a user can edit a page and
309 before showing the edit form ( EditPage::edit() ). This is triggered
310 on &action=edit.
311 $EditPage: the EditPage object
312
313 'AlternateUserMailer': Called before mail is sent so that mail could
314 be logged (or something else) instead of using PEAR or PHP's mail().
315 Return false to skip the regular method of sending mail. Return a
316 string to return a php-mail-error message containing the error.
317 Returning true will continue with sending email in the regular way.
318 $headers: Associative array of headers for the email
319 $to: MailAddress object or array
320 $from: From address
321 $subject: Subject of the email
322 $body: Body of the message
323
324 'APIAfterExecute': after calling the execute() method of an API module.
325 Use this to extend core API modules.
326 &$module: Module object
327
328 'ApiCheckCanExecute': Called during ApiMain::checkCanExecute. Use to
329 further authenticate and authorize API clients before executing the
330 module. Return false and set a message to cancel the request.
331 $module: Module object
332 $user: Current user
333 &$message: API usage message to die with, as a message key or array
334 as accepted by ApiBase::dieUsageMsg.
335
336 'APIEditBeforeSave': before saving a page with api.php?action=edit,
337 after processing request parameters. Return false to let the request
338 fail, returning an error message or an <edit result="Failure"> tag
339 if $resultArr was filled.
340 $EditPage : the EditPage object
341 $text : the new text of the article (has yet to be saved)
342 &$resultArr : data in this array will be added to the API result
343
344 'APIGetAllowedParams': use this hook to modify a module's parameters.
345 &$module: ApiBase Module object
346 &$params: Array of parameters
347
348 'APIGetDescription': use this hook to modify a module's description
349 &$module: ApiBase Module object
350 &$desc: Array of descriptions
351
352 'APIGetParamDescription': use this hook to modify a module's parameter
353 descriptions.
354 &$module: ApiBase Module object
355 &$desc: Array of parameter descriptions
356
357 'APIGetResultProperties': use this hook to mofify the properties
358 in a module's result.
359 &$module: ApiBase Module object
360 &$properties: Array of properties
361
362 'APIQueryAfterExecute': after calling the execute() method of an
363 action=query submodule. Use this to extend core API modules.
364 &$module: Module object
365
366 'APIQueryGeneratorAfterExecute': after calling the executeGenerator()
367 method of an action=query submodule. Use this to extend core API modules.
368 &$module: Module object
369 &$resultPageSet: ApiPageSet object
370
371 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
372 Every token has an action, which will be used in the intoken parameter
373 and in the output (actiontoken="..."), and a callback function which
374 should return the token, or false if the user isn't allowed to obtain
375 it. The prototype of the callback function is func($pageid, $title)
376 where $pageid is the page ID of the page the token is requested for
377 and $title is the associated Title object. In the hook, just add
378 your callback to the $tokenFunctions array and return true (returning
379 false makes no sense)
380 $tokenFunctions: array(action => callback)
381
382 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
383 Every token has an action, which will be used in the rvtoken parameter
384 and in the output (actiontoken="..."), and a callback function which
385 should return the token, or false if the user isn't allowed to obtain
386 it. The prototype of the callback function is func($pageid, $title, $rev)
387 where $pageid is the page ID of the page associated to the revision the
388 token is requested for, $title the associated Title object and $rev the
389 associated Revision object. In the hook, just add your callback to the
390 $tokenFunctions array and return true (returning false makes no sense)
391 $tokenFunctions: array(action => callback)
392
393 'APIQueryRecentChangesTokens': use this hook to add custom tokens to
394 list=recentchanges.
395 Every token has an action, which will be used in the rctoken parameter
396 and in the output (actiontoken="..."), and a callback function which
397 should return the token, or false if the user isn't allowed to obtain
398 it. The prototype of the callback function is func($pageid, $title, $rc)
399 where $pageid is the page ID of the page associated to the revision the
400 token is requested for, $title the associated Title object and $rc the
401 associated RecentChange object. In the hook, just add your callback to the
402 $tokenFunctions array and return true (returning false makes no sense)
403 $tokenFunctions: array(action => callback)
404
405 'APIQuerySiteInfoGeneralInfo': use this hook to add extra information to
406 the sites general information.
407 $module: the current ApiQuerySiteInfo module
408 &$results: array of results, add things here
409
410 'APIQueryUsersTokens': use this hook to add custom token to list=users.
411 Every token has an action, which will be used in the ustoken parameter
412 and in the output (actiontoken="..."), and a callback function which
413 should return the token, or false if the user isn't allowed to obtain
414 it. The prototype of the callback function is func($user) where $user
415 is the User object. In the hook, just add your callback to the
416 $tokenFunctions array and return true (returning false makes no sense)
417 $tokenFunctions: array(action => callback)
418
419 'ApiMain::onException': Called by ApiMain::executeActionWithErrorHandling()
420 when an exception is thrown during API action execution.
421 $apiMain: Calling ApiMain instance.
422 $e: Exception object.
423
424 'ApiRsdServiceApis': Add or remove APIs from the RSD services list.
425 Each service should have its own entry in the $apis array and have a
426 unique name, passed as key for the array that represents the service data.
427 In this data array, the key-value-pair identified by the apiLink key is
428 required.
429 &$apis: array of services
430
431 'ApiTokensGetTokenTypes': use this hook to extend action=tokens with new
432 token types.
433 &$tokenTypes: supported token types in format 'type' => callback function
434 used to retrieve this type of tokens.
435
436 'ArticleAfterFetchContent': after fetching content of an article from
437 the database. DEPRECATED, use ArticleAfterFetchContentObject instead.
438 $article: the article (object) being loaded from the database
439 &$content: the content (string) of the article
440
441 'ArticleAfterFetchContentObject': after fetching content of an article from
442 the database
443 $article: the article (object) being loaded from the database
444 &$content: the content of the article, as a Content object
445
446 'ArticleConfirmDelete': before writing the confirmation form for article
447 deletion
448 $article: the article (object) being deleted
449 $output: the OutputPage object ($wgOut)
450 &$reason: the reason (string) the article is being deleted
451
452 'ArticleContentOnDiff': before showing the article content below a diff.
453 Use this to change the content in this area or how it is loaded.
454 $diffEngine: the DifferenceEngine
455 $output: the OutputPage object ($wgOut)
456
457 'ArticleDelete': before an article is deleted
458 $article: the WikiPage (object) being deleted
459 $user: the user (object) deleting the article
460 $reason: the reason (string) the article is being deleted
461 $error: if the deletion was prohibited, the (raw HTML) error message to display
462 (added in 1.13)
463 $status: Status object, modify this to throw an error. Overridden by $error
464 (added in 1.20)
465
466 'ArticleDeleteComplete': after an article is deleted
467 $article: the WikiPage that was deleted
468 $user: the user that deleted the article
469 $reason: the reason the article was deleted
470 $id: id of the article that was deleted
471 $content: the Content of the deleted page
472 $logEntry: the ManualLogEntry used to record the deletion
473
474 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page
475 was changed
476 $article: WikiPage (object) of the user talk page
477
478 'ArticleEditUpdates': when edit updates (mainly link tracking) are made when an
479 article has been changed
480 $article: the WikiPage (object)
481 $editInfo: data holder that includes the parser output ($editInfo->output) for
482 that page after the change
483 $changed: bool for if the page was changed
484
485 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from
486 recentchanges table, return false to not delete old entries
487 $article: WikiPage (object) being modified
488
489 'ArticleFromTitle': when creating an article object from a title object using
490 Wiki::articleFromTitle()
491 $title: title (object) used to create the article object
492 $article: article (object) that will be returned
493
494 'ArticleInsertComplete': After a new article is created. DEPRECATED, use PageContentInsertComplete
495 $article: WikiPage created
496 $user: User creating the article
497 $text: New content
498 $summary: Edit summary/comment
499 $isMinor: Whether or not the edit was marked as minor
500 $isWatch: (No longer used)
501 $section: (No longer used)
502 $flags: Flags passed to WikiPage::doEditContent()
503 $revision: New Revision of the article
504
505 'ArticleMergeComplete': after merging to article using Special:Mergehistory
506 $targetTitle: target title (object)
507 $destTitle: destination title (object)
508
509 'ArticlePageDataAfter': after loading data of an article from the database
510 $article: WikiPage (object) whose data were loaded
511 $row: row (object) returned from the database server
512
513 'ArticlePageDataBefore': before loading data of an article from the database
514 $article: WikiPage (object) that data will be loaded
515 $fields: fileds (array) to load from the database
516
517 'ArticlePrepareTextForEdit': called when preparing text to be saved
518 $article: the WikiPage being saved
519 $popts: parser options to be used for pre-save transformation
520
521 'ArticleProtect': before an article is protected
522 $article: the WikiPage being protected
523 $user: the user doing the protection
524 $protect: boolean whether this is a protect or an unprotect
525 $reason: Reason for protect
526 $moveonly: boolean whether this is for move only or not
527
528 'ArticleProtectComplete': after an article is protected
529 $article: the WikiPage that was protected
530 $user: the user who did the protection
531 $protect: boolean whether it was a protect or an unprotect
532 $reason: Reason for protect
533 $moveonly: boolean whether it was for move only or not
534
535 'ArticlePurge': before executing "&action=purge"
536 $article: WikiPage (object) to purge
537
538 'ArticleRevisionVisibilitySet': called when changing visibility of one or more
539 revision of an article
540 &$title: title object of the article
541
542 'ArticleRevisionUndeleted': after an article revision is restored
543 $title: the article title
544 $revision: the revision
545 $oldPageID: the page ID of the revision when archived (may be null)
546
547 'ArticleRollbackComplete': after an article rollback is completed
548 $article: the WikiPage that was edited
549 $user: the user who did the rollback
550 $revision: the revision the page was reverted back to
551 $current: the reverted revision
552
553 'ArticleSave': before an article is saved. DEPRECATED, use PageContentSave instead
554 $article: the WikiPage (object) being saved
555 $user: the user (object) saving the article
556 $text: the new article text
557 $summary: the article summary (comment)
558 $isminor: minor flag
559 $iswatch: watch flag
560 $section: section #
561
562 'ArticleSaveComplete': After an article has been updated. DEPRECATED, use PageContentSaveComplete instead.
563 $article: WikiPage modified
564 $user: User performing the modification
565 $text: New content
566 $summary: Edit summary/comment
567 $isMinor: Whether or not the edit was marked as minor
568 $isWatch: (No longer used)
569 $section: (No longer used)
570 $flags: Flags passed to WikiPage::doEditContent()
571 $revision: New Revision of the article
572 $status: Status object about to be returned by doEditContent()
573 $baseRevId: the rev ID (or false) this edit was based on
574
575 'ArticleUndelete': When one or more revisions of an article are restored
576 $title: Title corresponding to the article restored
577 $create: Whether or not the restoration caused the page to be created
578 (i.e. it didn't exist before)
579 $comment: The comment associated with the undeletion.
580
581 'ArticleUndeleteLogEntry': When a log entry is generated but not yet saved.
582 $pageArchive: the PageArchive object
583 &$logEntry: ManualLogEntry object
584 $user: User who is performing the log action
585
586 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save),
587 before the user is redirected back to the page
588 &$article: the article
589 &$sectionanchor: The section anchor link (e.g. "#overview" )
590 &$extraq: Extra query parameters which can be added via hooked functions
591
592 'ArticleViewFooter': After showing the footer section of an ordinary page view
593 $article: Article object
594
595 'ArticleViewHeader': Before the parser cache is about to be tried for article
596 viewing.
597 &$article: the article
598 &$pcache: whether to try the parser cache or not
599 &$outputDone: whether the output for this page finished or not. Set to a ParserOutput
600 object to both indicate that the output is done and what parser output was used.
601
602 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when
603 follwed an redirect
604 $article: target article (object)
605
606 'ArticleViewCustom': allows to output the text of the article in a different format than wikitext.
607 DEPRECATED, use ArticleContentViewCustom instead.
608 Note that it is preferrable to implement proper handing for a custom data type using the ContentHandler facility.
609 $text: text of the page
610 $title: title of the page
611 $output: reference to $wgOut
612
613 'ArticleContentViewCustom': allows to output the text of the article in a different format than wikitext.
614 Note that it is preferrable to implement proper handing for a custom data type using the ContentHandler facility.
615 $content: content of the page, as a Content object
616 $title: title of the page
617 $output: reference to $wgOut
618
619 'AuthPluginAutoCreate': Called when creating a local account for an user logged
620 in from an external authentication method
621 $user: User object created locally
622
623 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
624 Gives a chance for an extension to set it programattically to a variable class.
625 &$auth: the $wgAuth object, probably a stub
626
627 'AutopromoteCondition': check autopromote condition for user.
628 $type: condition type
629 $args: arguments
630 $user: user
631 $result: result of checking autopromote condition
632
633 'BacklinkCacheGetPrefix': allows to set prefix for a spefific link table
634 $table: table name
635 &$prefix: prefix
636
637 'BacklinkCacheGetConditions': allows to set conditions for query when links to certain title
638 are fetched
639 $table: table name
640 $title: title of the page to which backlinks are sought
641 &$conds: query conditions
642
643 'BadImage': When checking against the bad image list
644 $name: Image name being checked
645 &$bad: Whether or not the image is "bad"
646
647 Change $bad and return false to override. If an image is "bad", it is not
648 rendered inline in wiki pages or galleries in category pages.
649
650 'BeforeDisplayNoArticleText': before displaying noarticletext or noarticletext-nopermission
651 at Article::showMissingArticle()
652
653 $article: article object
654
655 'BeforeInitialize': before anything is initialized in MediaWiki::performRequest()
656 &$title: Title being used for request
657 $unused: null
658 &$output: OutputPage object
659 &$user: User
660 $request: WebRequest object
661 $mediaWiki: Mediawiki object
662
663 'BeforePageDisplay': Prior to outputting a page
664 &$out: OutputPage object
665 &$skin: Skin object
666
667 'BeforePageRedirect': Prior to sending an HTTP redirect. Gives a chance to
668 override how the redirect is output by modifying, or by returning false and
669 taking over the output.
670 $out: OutputPage object
671 &$redirect: URL, modifiable
672 &$code: HTTP code (eg '301' or '302'), modifiable
673
674 'BeforeParserFetchFileAndTitle': before an image is rendered by Parser
675 $parser: Parser object
676 $nt: the image title
677 &$options: array of options to RepoGroup::findFile
678 &$descQuery: query string to add to thumbnail URL
679
680 If 'broken' is a key in $options then the file will appear as a broken thumbnail.
681
682 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
683 $parser: Parser object
684 $title: title of the template
685 &$skip: skip this template and link it?
686 &$id: the id of the revision being parsed
687
688 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
689 &$parser: Parser object
690 &$ig: ImageGallery object
691
692 'BeforeWelcomeCreation': before the welcomecreation message is displayed to a newly created user
693 &$welcome_creation_msg: MediaWiki message name to display on the welcome screen to a newly created user account
694 &$injected_html: Any HTML to inject after the "logged in" message of a newly created user account
695
696 'BitmapHandlerTransform': before a file is transformed, gives extension the
697 possibility to transform it themselves
698 $handler: BitmapHandler
699 $image: File
700 &$scalerParams: Array with scaler parameters
701 &$mto: null, set to a MediaTransformOutput
702
703 'BitmapHandlerCheckImageArea': by BitmapHandler::normaliseParams, after all normalizations have been performed, except for the $wgMaxImageArea check
704 $image: File
705 &$params: Array of parameters
706 &$checkImageAreaHookResult: null, set to true or false to override the $wgMaxImageArea check result
707
708 'PerformRetroactiveAutoblock': called before a retroactive autoblock is applied to a user
709 $block: Block object (which is set to be autoblocking)
710 &$blockIds: Array of block IDs of the autoblock
711
712 'BlockIp': before an IP address or user is blocked
713 $block: the Block object about to be saved
714 $user: the user _doing_ the block (not the one being blocked)
715
716 'BlockIpComplete': after an IP address or user is blocked
717 $block: the Block object that was saved
718 $user: the user who did the block (not the one being blocked)
719
720 'BookInformation': Before information output on Special:Booksources
721 $isbn: ISBN to show information for
722 $output: OutputPage object in use
723
724 'CanonicalNamespaces': For extensions adding their own namespaces or altering the defaults
725 &$namespaces: Array of namespace numbers with corresponding canonical names
726
727 'CategoryPageView': before viewing a categorypage in CategoryPage::view
728 $catpage: CategoryPage instance
729
730 'ChangePasswordForm': For extensions that need to add a field to the ChangePassword form
731 via the Preferences form
732 &$extraFields: An array of arrays that hold fields like would be passed to the pretty function.
733
734 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
735 &$changesList: ChangesList instance.
736 &$articlelink: HTML of link to article (already filled-in).
737 &$s: HTML of row that is being constructed.
738 &$rc: RecentChange instance.
739 $unpatrolled: Whether or not we are showing unpatrolled changes.
740 $watched: Whether or not the change is watched by the user.
741
742 'Collation::factory': Called if $wgCategoryCollation is an unknown collation
743 $collationName: Name of the collation in question
744 &$collationObject: Null. Replace with a subclass of the Collation class that implements
745 the collation given in $collationName.
746
747 'ConfirmEmailComplete': Called after a user's email has been confirmed successfully
748 $user: user (object) whose email is being confirmed
749
750 'ContentHandlerDefaultModelFor': Called when the default content model is determiend
751 for a given title. May be used to assign a different model for that title.
752 $title: the Title in question
753 &$model: the model name. Use with CONTENT_MODEL_XXX constants.
754
755 'ContentHandlerForModelID': Called when a ContentHandler is requested for a given
756 content model name, but no entry for that model exists in $wgContentHandlers.
757 $modeName: the requested content model name
758 &$handler: set this to a ContentHandler object, if desired.
759
760 'ConvertContent': Called by AbstractContent::convert when a conversion to another
761 content model is requested.
762 $content: The Content object to be converted.
763 $toModel: The ID of the content model to convert to.
764 $lossy: boolean indicating whether lossy conversion is allowed.
765 &$result: Output parameter, in case the handler function wants to provide a
766 converted Content object. Note that $result->getContentModel() must return $toModel.
767 Handler functions that modify $result should generally return false to further
768 attempts at conversion.
769
770 'ContribsPager::getQueryInfo': Before the contributions query is about to run
771 &$pager: Pager object for contributions
772 &$queryInfo: The query for the contribs Pager
773
774 'ContribsPager::reallyDoQuery': Called before really executing the query for My Contributions
775 &$data: an array of results of all contribs queries
776 $pager: The ContribsPager object hooked into
777 $offset: Index offset, inclusive
778 $limit: Exact query limit
779 $descending: Query direction, false for ascending, true for descending
780
781 'ContributionsLineEnding': Called before a contributions HTML line is finished
782 $page: SpecialPage object for contributions
783 &$ret: the HTML line
784 $row: the DB row for this line
785 &$classes: the classes to add to the surrounding <li>
786
787 'ContributionsToolLinks': Change tool links above Special:Contributions
788 $id: User identifier
789 $title: User page title
790 &$tools: Array of tool links
791
792 'CustomEditor': When invoking the page editor
793 $article: Article being edited
794 $user: User performing the edit
795
796 Return true to allow the normal editor to be used, or false
797 if implementing a custom editor, e.g. for a special namespace,
798 etc.
799
800 'DatabaseOraclePostInit': Called after initialising an Oracle database
801 &$db: the DatabaseOracle object
802
803 'Debug': called when outputting a debug log line via wfDebug() or wfDebugLog()
804 $text: plaintext string to be output
805 $group: null or a string naming a logging group (as defined in $wgDebugLogGroups)
806
807 'NewDifferenceEngine': Called when a new DifferenceEngine object is made
808 $title: the diff page title (nullable)
809 &$oldId: the actual old Id to use in the diff
810 &$newId: the actual new Id to use in the diff (0 means current)
811 $old: the ?old= param value from the url
812 $new: the ?new= param value from the url
813
814 'DiffViewHeader': called before diff display
815 $diff: DifferenceEngine object that's calling
816 $oldRev: Revision object of the "old" revision (may be null/invalid)
817 $newRev: Revision object of the "new" revision
818
819 'DisplayOldSubtitle': before creating subtitle when browsing old versions of
820 an article
821 $article: article (object) being viewed
822 $oldid: oldid (int) being viewed
823
824 'DoEditSectionLink': Override the HTML generated for section edit links
825 $skin: Skin object rendering the UI
826 $title: Title object for the title being linked to (may not be the same as
827 $wgTitle, if the section is included from a template)
828 $section: The designation of the section being pointed to, to be included in
829 the link, like "&section=$section"
830 $tooltip: The default tooltip. Escape before using.
831 By default, this is wrapped in the 'editsectionhint' message.
832 &$result: The HTML to return, prefilled with the default plus whatever other
833 changes earlier hooks have made
834 $lang: The language code to use for the link in the wfMessage function
835
836 'EditFilter': Perform checks on an edit
837 $editor: EditPage instance (object). The edit form (see includes/EditPage.php)
838 $text: Contents of the edit box
839 $section: Section being edited
840 &$error: Error message to return
841 $summary: Edit summary for page
842
843 'EditFilterMerged': Post-section-merge edit filter.
844 DEPRECATED, use EditFilterMergedContent instead.
845 $editor: EditPage instance (object)
846 $text: content of the edit box
847 &$error: error message to return
848 $summary: Edit summary for page
849
850 'EditFilterMergedContent': Post-section-merge edit filter
851 $editor: EditPage instance (object)
852 $content: content of the edit box, as a Content object
853 &$error: error message to return
854 $summary: Edit summary for page
855
856 'EditFormPreloadText': Allows population of the edit form when creating
857 new pages
858 &$text: Text to preload with
859 &$title: Title object representing the page being created
860
861 'EditFormInitialText': Allows modifying the edit form when editing existing
862 pages
863 $editPage: EditPage object
864
865 'EditPage::attemptSave': called before an article is
866 saved, that is before WikiPage::doEditContent() is called
867 $editpage_Obj: the current EditPage object
868
869 'EditPage::importFormData': allow extensions to read additional data
870 posted in the form
871 $editpage: EditPage instance
872 $request: Webrequest
873 return value is ignored (should always return true)
874
875 'EditPage::showEditForm:fields': allows injection of form field into edit form
876 $editor: the EditPage instance for reference
877 $out: an OutputPage instance to write to
878 return value is ignored (should always return true)
879
880 'EditPage::showEditForm:initial': before showing the edit form
881 $editor: EditPage instance (object)
882 $out: an OutputPage instance to write to
883
884 Return false to halt editing; you'll need to handle error messages, etc.
885 yourself. Alternatively, modifying $error and returning true will cause the
886 contents of $error to be echoed at the top of the edit form as wikitext.
887 Return true without altering $error to allow the edit to proceed.
888
889 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
890 when there's an edit conflict. Return false to halt normal diff output; in
891 this case you're responsible for computing and outputting the entire "conflict"
892 part, i.e., the "difference between revisions" and "your text" headers and
893 sections.
894 &$editor: EditPage instance
895 &$out: OutputPage instance
896
897 'EditPageBeforeEditButtons': allows modifying the edit buttons below the
898 textarea in the edit form
899 &$editpage: The current EditPage object
900 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
901 &$tabindex: HTML tabindex of the last edit check/button
902
903 'EditPageBeforeEditChecks': allows modifying the edit checks below the
904 textarea in the edit form
905 &$editpage: The current EditPage object
906 &$checks: Array of edit checks like "watch this page"/"minor edit"
907 &$tabindex: HTML tabindex of the last edit check/button
908
909 'EditPageBeforeEditToolbar': allows modifying the edit toolbar above the
910 textarea in the edit form
911 &$toolbar: The toolbar HTMl
912
913 'EditPageCopyrightWarning': Allow for site and per-namespace customization of contribution/copyright notice.
914 $title: title of page being edited
915 &$msg: localization message name, overridable. Default is either 'copyrightwarning' or 'copyrightwarning2'
916
917 'EditPageGetDiffText': Allow modifying the wikitext that will be used in
918 "Show changes". DEPRECATED. Use EditPageGetDiffContent instead.
919 Note that it is preferrable to implement diff handling for different data types using the ContentHandler facility.
920 $editPage: EditPage object
921 &$newtext: wikitext that will be used as "your version"
922
923 'EditPageGetDiffContent': Allow modifying the wikitext that will be used in
924 "Show changes".
925 Note that it is preferrable to implement diff handling for different data types using the ContentHandler facility.
926 $editPage: EditPage object
927 &$newtext: wikitext that will be used as "your version"
928
929 'EditPageGetPreviewText': Allow modifying the wikitext that will be previewed.
930 DEPRECATED. Use EditPageGetPreviewContent instead.
931 Note that it is preferrable to implement previews for different data types using the COntentHandler facility.
932 $editPage: EditPage object
933 &$toparse: wikitext that will be parsed
934
935 'EditPageGetPreviewContent': Allow modifying the wikitext that will be previewed.
936 Note that it is preferrable to implement previews for different data types using the COntentHandler facility.
937 $editPage: EditPage object
938 &$content: Content object to be previewed (may be replaced by hook function)
939
940 'EditPageNoSuchSection': When a section edit request is given for an non-existent section
941 &$editpage: The current EditPage object
942 &$res: the HTML of the error text
943
944 'EditPageTosSummary': Give a chance for site and per-namespace customizations
945 of terms of service summary link that might exist separately from the copyright
946 notice.
947 $title: title of page being edited
948 &$msg: localization message name, overridable. Default is 'editpage-tos-summary'
949
950 'EditSectionLink': Do not use, use DoEditSectionLink instead.
951 $skin: Skin rendering the UI
952 $title: Title being linked to
953 $section: Section to link to
954 $link: Default link
955 &$result: Result (alter this to override the generated links)
956 $lang: The language code to use for the link in the wfMessage function
957
958 'EmailConfirmed': When checking that the user's email address is "confirmed"
959 $user: User being checked
960 $confirmed: Whether or not the email address is confirmed
961 This runs before the other checks, such as anonymity and the real check; return
962 true to allow those checks to occur, and false if checking is done.
963
964 'EmailUser': before sending email from one user to another
965 $to: address of receiving user
966 $from: address of sending user
967 $subject: subject of the mail
968 $text: text of the mail
969
970 'EmailUserCC': before sending the copy of the email to the author
971 $to: address of receiving user
972 $from: address of sending user
973 $subject: subject of the mail
974 $text: text of the mail
975
976 'EmailUserComplete': after sending email from one user to another
977 $to: address of receiving user
978 $from: address of sending user
979 $subject: subject of the mail
980 $text: text of the mail
981
982 'EmailUserForm': after building the email user form object
983 $form: HTMLForm object
984
985 'EmailUserPermissionsErrors': to retrieve permissions errors for emailing a user.
986 $user: The user who is trying to email another user.
987 $editToken: The user's edit token.
988 &$hookErr: Out-param for the error. Passed as the parameters to OutputPage::showErrorPage.
989
990 'ExemptFromAccountCreationThrottle': Exemption from the account creation throttle
991 $ip: The ip address of the user
992
993 'ExtensionTypes': called when generating the extensions credits, use this to change the tables headers
994 &$extTypes: associative array of extensions types
995
996 'ExtractThumbParameters': called when extracting thumbnail parameters from a thumbnail file name
997 $thumbname: the base name of the thumbnail file
998 &$params: the currently extracted params (has source name, temp or archived zone)
999
1000 'FetchChangesList': When fetching the ChangesList derivative for
1001 a particular user
1002 $user: User the list is being fetched for
1003 &$skin: Skin object to be used with the list
1004 &$list: List object (defaults to NULL, change it to an object
1005 instance and return false override the list derivative used)
1006
1007 'FileDeleteComplete': When a file is deleted
1008 $file: reference to the deleted file
1009 $oldimage: in case of the deletion of an old image, the name of the old file
1010 $article: in case all revisions of the file are deleted a reference to the
1011 WikiFilePage associated with the file.
1012 $user: user who performed the deletion
1013 $reason: reason
1014
1015 'FileTransformed': When a file is transformed and moved into storage
1016 $file: reference to the File object
1017 $thumb: the MediaTransformOutput object
1018 $tmpThumbPath: The temporary file system path of the transformed file
1019 $thumbPath: The permanent storage path of the transformed file
1020
1021 'FileUpload': When a file upload occurs
1022 $file : Image object representing the file that was uploaded
1023 $reupload : Boolean indicating if there was a previously another image there or not (since 1.17)
1024 $hasDescription : Boolean indicating that there was already a description page and a new one from the comment wasn't created (since 1.17)
1025
1026 'FileUndeleteComplete': When a file is undeleted
1027 $title: title object to the file
1028 $fileVersions: array of undeleted versions. Empty if all versions were restored
1029 $user: user who performed the undeletion
1030 $reason: reason
1031
1032 'FormatAutocomments': When an autocomment is formatted by the Linker
1033 &$comment: Reference to the accumulated comment. Initially null, when set the default code will be skipped.
1034 $pre: Initial part of the parsed comment before the call to the hook.
1035 $auto: The extracted part of the parsed comment before the call to the hook.
1036 $post: The final part of the parsed comment before the call to the hook.
1037 $title: An optional title object used to links to sections. Can be null.
1038 $local: Boolean indicating whether section links should refer to local page.
1039
1040 'GetAutoPromoteGroups': When determining which autopromote groups a user
1041 is entitled to be in.
1042 &$user: user to promote.
1043 &$promote: groups that will be added.
1044
1045 'GetBlockedStatus': after loading blocking status of an user from the database
1046 $user: user (object) being checked
1047
1048 'GetCacheVaryCookies': get cookies that should vary cache options
1049 $out: OutputPage object
1050 &$cookies: array of cookies name, add a value to it if you want to add a cookie
1051 that have to vary cache options
1052
1053 'GetCanonicalURL': modify fully-qualified URLs used for IRC and e-mail notifications
1054 $title: Title object of page
1055 $url: string value as output (out parameter, can modify)
1056 $query: query options passed to Title::getCanonicalURL()
1057
1058 'GetDefaultSortkey': Override the default sortkey for a page.
1059 $title: Title object that we need to get a sortkey for
1060 &$sortkey: Sortkey to use.
1061
1062 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
1063 $title: Title object of page
1064 $url: string value as output (out parameter, can modify)
1065 $query: query options passed to Title::getFullURL()
1066
1067 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
1068 $title: Title object of page
1069 $url: string value as output (out parameter, can modify)
1070 $query: query options passed to Title::getInternalURL()
1071
1072 'GetIP': modify the ip of the current user (called only once)
1073 &$ip: string holding the ip as determined so far
1074
1075 'GetLinkColours': modify the CSS class of an array of page links
1076 $linkcolour_ids: array of prefixed DB keys of the pages linked to,
1077 indexed by page_id.
1078 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
1079
1080 'GetLocalURL': modify local URLs as output into page links. Note that if you
1081 are working with internal urls (non-interwiki) then it may be preferable
1082 to work with the GetLocalURL::Internal or GetLocalURL::Article hooks as
1083 GetLocalURL can be buggy for internal urls on render if you do not
1084 re-implement the horrible hack that Title::getLocalURL uses
1085 in your own extension.
1086 $title: Title object of page
1087 &$url: string value as output (out parameter, can modify)
1088 $query: query options passed to Title::getLocalURL()
1089
1090 'GetLocalURL::Internal': modify local URLs to internal pages.
1091 $title: Title object of page
1092 &$url: string value as output (out parameter, can modify)
1093 $query: query options passed to Title::getLocalURL()
1094
1095 'GetLocalURL::Article': modify local URLs specifically pointing to article paths
1096 without any fancy queries or variants.
1097 $title: Title object of page
1098 &$url: string value as output (out parameter, can modify)
1099
1100 'GetMetadataVersion': modify the image metadata version currently in use. This is
1101 used when requesting image metadata from a ForiegnApiRepo. Media handlers
1102 that need to have versioned metadata should add an element to the end of
1103 the version array of the form 'handler_name=version'. Most media handlers
1104 won't need to do this unless they broke backwards compatibility with a
1105 previous version of the media handler metadata output.
1106 &$version: Array of version strings
1107
1108 'GetPreferences': modify user preferences
1109 $user: User whose preferences are being modified.
1110 &$preferences: Preferences description array, to be fed to an HTMLForm object
1111
1112 'getUserPermissionsErrors': Add a permissions error when permissions errors are
1113 checked for. Use instead of userCan for most cases. Return false if the
1114 user can't do it, and populate $result with the reason in the form of
1115 array( messagename, param1, param2, ... ). For consistency, error messages
1116 should be plain text with no special coloring, bolding, etc. to show that
1117 they're errors; presenting them properly to the user as errors is done by
1118 the caller.
1119 $title: Title object being checked against
1120 $user : Current user object
1121 $action: Action being checked
1122 $result: User permissions error to add. If none, return true.
1123
1124 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
1125 if expensive checks are enabled.
1126
1127 'GitViewers': called when generating the list of git viewers for Special:Version, use
1128 this to change the list.
1129 &$extTypes: associative array of repo URLS to viewer URLs.
1130
1131
1132 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
1133 image insertion. You can skip the default logic entirely by returning
1134 false, or just modify a few things using call-by-reference.
1135 &$skin: Skin object
1136 &$title: Title object of the image
1137 &$file: File object, or false if it doesn't exist
1138 &$frameParams: Various parameters with special meanings; see documentation in
1139 includes/Linker.php for Linker::makeImageLink
1140 &$handlerParams: Various parameters with special meanings; see documentation in
1141 includes/Linker.php for Linker::makeImageLink
1142 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
1143 &$res: Final HTML output, used if you return false
1144
1145
1146 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
1147 the image on an image page
1148 $imagePage: ImagePage object ($this)
1149 $output: $wgOut
1150
1151 'ImagePageAfterImageLinks': called after the image links section on an image
1152 page is built
1153 $imagePage: ImagePage object ($this)
1154 &$html: HTML for the hook to add
1155
1156 'ImagePageFileHistoryLine': called when a file history line is contructed
1157 $file: the file
1158 $line: the HTML of the history line
1159 $css: the line CSS class
1160
1161 'ImagePageFindFile': called when fetching the file associated with an image page
1162 $page: ImagePage object
1163 &$file: File object
1164 &$displayFile: displayed File object
1165
1166 'ImagePageShowTOC': called when the file toc on an image page is generated
1167 $page: ImagePage object
1168 &$toc: Array of <li> strings
1169
1170 'ImgAuthBeforeStream': executed before file is streamed to user, but only when
1171 using img_auth.php
1172 &$title: the Title object of the file as it would appear for the upload page
1173 &$path: the original file and path name when img_auth was invoked by the the web
1174 server
1175 &$name: the name only component of the file
1176 &$result: The location to pass back results of the hook routine (only used if
1177 failed)
1178 $result[0]=The index of the header message
1179 $result[1]=The index of the body text message
1180 $result[2 through n]=Parameters passed to body text message. Please note the
1181 header message cannot receive/use parameters.
1182
1183 'ImportHandleLogItemXMLTag': When parsing a XML tag in a log item
1184 $reader: XMLReader object
1185 $logInfo: Array of information
1186 Return false to stop further processing of the tag
1187
1188 'ImportHandlePageXMLTag': When parsing a XML tag in a page
1189 $reader: XMLReader object
1190 $pageInfo: Array of information
1191 Return false to stop further processing of the tag
1192
1193 'ImportHandleRevisionXMLTag': When parsing a XML tag in a page revision
1194 $reader: XMLReader object
1195 $pageInfo: Array of page information
1196 $revisionInfo: Array of revision information
1197 Return false to stop further processing of the tag
1198
1199 'ImportHandleToplevelXMLTag': When parsing a top level XML tag
1200 $reader: XMLReader object
1201 Return false to stop further processing of the tag
1202
1203 'ImportHandleUploadXMLTag': When parsing a XML tag in a file upload
1204 $reader: XMLReader object
1205 $revisionInfo: Array of information
1206 Return false to stop further processing of the tag
1207
1208 'InfoAction': When building information to display on the action=info page
1209 $context: IContextSource object
1210 &$pageInfo: Array of information
1211
1212 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
1213 $title: Title object ($wgTitle)
1214 $request: WebRequest
1215 $ignoreRedirect: boolean to skip redirect check
1216 $target: Title/string of redirect target
1217 $article: Article object
1218
1219 'InterwikiLoadPrefix': When resolving if a given prefix is an interwiki or not.
1220 Return true without providing an interwiki to continue interwiki search.
1221 $prefix: interwiki prefix we are looking for.
1222 &$iwData: output array describing the interwiki with keys iw_url, iw_local,
1223 iw_trans and optionally iw_api and iw_wikiid.
1224
1225 'InternalParseBeforeSanitize': during Parser's internalParse method just before the
1226 parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/
1227 onlyinclude and other processings. Ideal for syntax-extensions after template/parser
1228 function execution which respect nowiki and HTML-comments.
1229 &$parser: Parser object
1230 &$text: string containing partially parsed text
1231 &$stripState: Parser's internal StripState object
1232
1233 'InternalParseBeforeLinks': during Parser's internalParse method before links
1234 but after nowiki/noinclude/includeonly/onlyinclude and other processings.
1235 &$parser: Parser object
1236 &$text: string containing partially parsed text
1237 &$stripState: Parser's internal StripState object
1238
1239 'InvalidateEmailComplete': Called after a user's email has been invalidated successfully
1240 $user: user (object) whose email is being invalidated
1241
1242 'IRCLineURL': When constructing the URL to use in an IRC notification.
1243 Callee may modify $url and $query, URL will be constructed as $url . $query
1244 &$url: URL to index.php
1245 &$query: Query string
1246
1247 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
1248 $article: article (object) being checked
1249
1250 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
1251 $ip: IP being check
1252 $result: Change this value to override the result of wfIsTrustedProxy()
1253
1254 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
1255 tance to return false if the domain name doesn't match your organization
1256 $addr: The e-mail address entered by the user
1257 &$result: Set this and return false to override the internal checks
1258
1259 'isValidPassword': Override the result of User::isValidPassword()
1260 $password: The password entered by the user
1261 &$result: Set this and return false to override the internal checks
1262 $user: User the password is being validated for
1263
1264 'Language::getMessagesFileName':
1265 $code: The language code or the language we're looking for a messages file for
1266 &$file: The messages file path, you can override this to change the location.
1267
1268 'LanguageGetNamespaces': Provide custom ordering for namespaces or
1269 remove namespaces. Do not use this hook to add namespaces. Use
1270 CanonicalNamespaces for that.
1271 &$namespaces: Array of namespaces indexed by their numbers
1272
1273 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1274 $wgExtensionMessagesFiles instead.
1275 Use this to define synonyms of magic words depending of the language
1276 $magicExtensions: associative array of magic words synonyms
1277 $lang: laguage code (string)
1278
1279 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1280 listed in $wgExtensionMessagesFiles instead.
1281 Use to define aliases of special pages names depending of the language
1282 $specialPageAliases: associative array of magic words synonyms
1283 $lang: laguage code (string)
1284
1285 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1286 &$names: array of language code => language name
1287 $code language of the preferred translations
1288
1289 'LinkBegin': Used when generating internal and interwiki links in
1290 Linker::link(), before processing starts. Return false to skip default proces-
1291 sing and return $ret. See documentation for Linker::link() for details on the
1292 expected meanings of parameters.
1293 $skin: the Skin object
1294 $target: the Title that the link is pointing to
1295 &$html: the contents that the <a> tag should have (raw HTML); null means "de-
1296 fault"
1297 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
1298 tive array form, with keys and values unescaped. Should be merged with de-
1299 fault values, with a value of false meaning to suppress the attribute.
1300 &$query: the query string to add to the generated URL (the bit after the "?"),
1301 in associative array form, with keys and values unescaped.
1302 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1303 &$ret: the value to return if your hook returns false.
1304
1305 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1306 just before the function returns a value. If you return true, an <a> element
1307 with HTML attributes $attribs and contents $html will be returned. If you re-
1308 turn false, $ret will be returned.
1309 $skin: the Skin object
1310 $target: the Title object that the link is pointing to
1311 $options: the options. Will always include either 'known' or 'broken', and may
1312 include 'noclasses'.
1313 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1314 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1315 ciative array form.
1316 &$ret: the value to return if your hook returns false.
1317
1318 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1319 before the return
1320 &$url: the image url
1321 &$alt: the image's alt text
1322 &$img: the new image HTML (if returning false)
1323
1324 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1325 before the return
1326 &$url: the link url
1327 &$text: the link text
1328 &$link: the new link HTML (if returning false)
1329 &$attribs: the attributes to be applied.
1330 $linkType: The external link type
1331
1332 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1333 actual update
1334 &$linksUpdate: the LinksUpdate object
1335
1336 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1337 completed
1338 &$linksUpdate: the LinksUpdate object
1339
1340 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1341 &$linksUpdate: the LinksUpdate object
1342
1343 'ListDefinedTags': When trying to find all defined tags.
1344 &$tags: The list of tags.
1345
1346 'LoadExtensionSchemaUpdates': called during database installation and updates
1347 &updater: A DatabaseUpdater subclass
1348
1349 'LocalFile::getHistory': called before file history query performed
1350 $file: the File object
1351 $tables: tables
1352 $fields: select fields
1353 $conds: conditions
1354 $opts: query options
1355 $join_conds: JOIN conditions
1356
1357 'LocalFilePurgeThumbnails': called before thumbnails for a local file a purged
1358 $file: the File object
1359 $archiveName: name of an old file version or false if it's the current one
1360
1361 'LocalisationCacheRecache': Called when loading the localisation data into cache
1362 $cache: The LocalisationCache object
1363 $code: language code
1364 &$alldata: The localisation data from core and extensions
1365
1366 'LogEventsListShowLogExtract': called before the string is added to OutputPage. Returning false will prevent the string from being added to the OutputPage
1367 &$s: html string to show for the log extract
1368 $types: String or Array Log types to show
1369 $page: String or Title The page title to show log entries for
1370 $user: String The user who made the log entries
1371 $param: Associative Array with the following additional options:
1372 - lim Integer Limit of items to show, default is 50
1373 - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
1374 - showIfEmpty boolean Set to false if you don't want any output in case the loglist is empty if set to true (default), "No matching items in log" is displayed if loglist is empty
1375 - msgKey Array If you want a nice box with a message, set this to the key of the message. First element is the message key, additional optional elements are parameters for the key that are processed with wfMessage()->params()->parseAsBlock()
1376 - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset
1377 - wrap String Wrap the message in html (usually something like "&lt;div ...>$1&lt;/div>").
1378 - flags Integer display flags (NO_ACTION_LINK,NO_EXTRA_USER_LINKS)
1379
1380 'LoggableUserIPData': called when IP data for a user action can be logged by extensions like CheckUser.
1381 This is intended for when users do things that do not already create edits or log entries.
1382 $context: The context the of the action, which includes the user and request
1383 $data: Associative array of data for handlers to record. It must include values for:
1384 - 'namespace' Integer namespace for target title (NS_SPECIAL is allowed)
1385 - 'title' Database key string for target title (empty string if not applicable)
1386 - 'pageid' Integer page ID for target title (zero if not applicable)
1387 - 'action' Wikitext string in the same format as an edit summary
1388 - 'comment' Wikitext string in the same format as an edit summary
1389 - 'timestamp' Timestamp when the action occured
1390
1391 'LoginAuthenticateAudit': a login attempt for a valid user account either
1392 succeeded or failed. No return data is accepted; this hook is for auditing only.
1393 $user: the User object being authenticated against
1394 $password: the password being submitted and found wanting
1395 $retval: a LoginForm class constant with authenticateUserData() return
1396 value (SUCCESS, WRONG_PASS, etc)
1397
1398 'LogLine': Processes a single log entry on Special:Log
1399 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1400 logging.log_type database field.
1401 $log_action: string for the type of log action (e.g. 'delete', 'block',
1402 'create2'). Corresponds to logging.log_action database field.
1403 $title: Title object that corresponds to logging.log_namespace and
1404 logging.log_title database fields.
1405 $paramArray: Array of parameters that corresponds to logging.log_params field.
1406 Note that only $paramArray[0] appears to contain anything.
1407 &$comment: string that corresponds to logging.log_comment database field, and
1408 which is displayed in the UI.
1409 &$revert: string that is displayed in the UI, similar to $comment.
1410 $time: timestamp of the log entry (added in 1.12)
1411
1412 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance script
1413 $refreshLinks: RefreshLinks object
1414
1415 'MagicWordwgVariableIDs': When definig new magic words IDs.
1416 $variableIDs: array of strings
1417
1418 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1419 is executed. Ideally, this hook should only be used to add variables that
1420 depend on the current page/request; static configuration should be added
1421 through ResourceLoaderGetConfigVars instead.
1422 &$vars: variable (or multiple variables) to be added into the output
1423 of Skin::makeVariablesScript
1424 $out: The OutputPage which called the hook,
1425 can be used to get the real title
1426
1427 'MarkPatrolled': before an edit is marked patrolled
1428 $rcid: ID of the revision to be marked patrolled
1429 $user: the user (object) marking the revision as patrolled
1430 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1431 needs to be a sysop in order to mark an edit patrolled
1432
1433 'MarkPatrolledComplete': after an edit is marked patrolled
1434 $rcid: ID of the revision marked as patrolled
1435 $user: user (object) who marked the edit patrolled
1436 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1437 must be a sysop to patrol the edit
1438
1439 'MediaWikiPerformAction': Override MediaWiki::performAction().
1440 Use this to do something completely different, after the basic
1441 globals have been set up, but before ordinary actions take place.
1442 $output: $wgOut
1443 $article: $wgArticle
1444 $title: $wgTitle
1445 $user: $wgUser
1446 $request: $wgRequest
1447 $mediaWiki: The $mediawiki object
1448
1449 'MessagesPreLoad': When loading a message from the database
1450 $title: title of the message (string)
1451 $message: value (string), change it to the message you want to define
1452
1453 'MessageCacheReplace': When a message page is changed.
1454 Useful for updating caches.
1455 $title: name of the page changed.
1456 $text: new contents of the page.
1457
1458 'ModifyExportQuery': Modify the query used by the exporter.
1459 $db: The database object to be queried.
1460 &$tables: Tables in the query.
1461 &$conds: Conditions in the query.
1462 &$opts: Options for the query.
1463 &$join_conds: Join conditions for the query.
1464
1465 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1466 been rendered (useful for adding more)
1467 Note: this is only run for the Monobook skin. This hook is deprecated and
1468 may be removed in the future. To add items to the toolbox you should use
1469 the SkinTemplateToolboxEnd hook instead, which works for all
1470 "SkinTemplate"-type skins.
1471 $tools: array of tools
1472
1473 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1474 and returning it for the skin to output. You can add items to the toolbox while
1475 still letting the skin make final decisions on skin-specific markup conventions
1476 using this hook.
1477 &$sk: The BaseTemplate base skin template
1478 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1479 BaseTemplate::makeListItem for details on the format of individual
1480 items inside of this array
1481
1482 'NamespaceIsMovable': Called when determining if it is possible to pages in a namespace.
1483 $index: Integer; the index of the namespace being checked.
1484 $result: Boolean; whether MediaWiki currently thinks that pages in this namespace are movable.
1485 Hooks may change this value to override the return value of MWNamespace::isMovable()
1486
1487 'NewRevisionFromEditComplete': called when a revision was inserted
1488 due to an edit
1489 $article: the WikiPage edited
1490 $rev: the new revision
1491 $baseID: the revision ID this was based off, if any
1492 $user: the editing user
1493
1494 'NormalizeMessageKey': Called before the software gets the text of a message
1495 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1496 displayed
1497 &$key: the message being looked up. Change this to something else to change
1498 what message gets displayed (string)
1499 &$useDB: whether or not to look up the message in the database (bool)
1500 &$langCode: the language code to get the message for (string) - or -
1501 whether to use the content language (true) or site language (false) (bool)
1502 &$transform: whether or not to expand variables and templates
1503 in the message (bool)
1504
1505 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1506 &$changeslist: The OldChangesList instance.
1507 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1508 &$rc: The RecentChange object.
1509
1510 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1511 Hooks can alter or append to the array of URLs for search & suggestion formats.
1512 &$urls: array of associative arrays with Url element attributes
1513
1514 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1515 users and/or IP addresses too
1516 $otherBlockLink: An array with links to other block logs
1517 $ip: The requested IP address or username
1518
1519 'OutputPageBeforeHTML': a page has been processed by the parser and
1520 the resulting HTML is about to be displayed.
1521 $parserOutput: the parserOutput (object) that corresponds to the page
1522 $text: the text that will be displayed, in HTML (string)
1523
1524 'OutputPageBodyAttributes': called when OutputPage::headElement is creating the body
1525 tag to allow for extensions to add attributes to the body of the page they might
1526 need. Or to allow building extensions to add body classes that aren't of high
1527 enough demand to be included in core.
1528 $out: The OutputPage which called the hook, can be used to get the real title
1529 $sk: The Skin that called OutputPage::headElement
1530 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1531
1532 'OutputPageCheckLastModified': when checking if the page has been modified
1533 since the last visit
1534 &$modifiedTimes: array of timestamps.
1535 The following keys are set: page, user, epoch
1536
1537 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1538 $out: OutputPage instance (object)
1539 $parserOutput: parserOutput instance being added in $out
1540
1541 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1542 categories. Implementations should return false if they generate the category
1543 links, so the default link generation is skipped.
1544 $out: OutputPage instance (object)
1545 $categories: associative array, keys are category names, values are category
1546 types ("normal" or "hidden")
1547 $links: array, intended to hold the result. Must be an associative array with
1548 category types as keys and arrays of HTML links as values.
1549
1550 'PageContentInsertComplete': After a new article is created
1551 $article: WikiPage created
1552 $user: User creating the article
1553 $content: New content as a Content object
1554 $summary: Edit summary/comment
1555 $isMinor: Whether or not the edit was marked as minor
1556 $isWatch: (No longer used)
1557 $section: (No longer used)
1558 $flags: Flags passed to WikiPage::doEditContent()
1559 $revision: New Revision of the article
1560
1561 'PageContentLanguage': allows changing the language in which the content of
1562 a page is written. Defaults to the wiki content language ($wgContLang).
1563 $title: Title object
1564 &$pageLang: the page content language (either an object or a language code)
1565 $wgLang: the user language
1566
1567 'PageContentSave': before an article is saved.
1568 $article: the WikiPage (object) being saved
1569 $user: the user (object) saving the article
1570 $content: the new article content, as a Content object
1571 $summary: the article summary (comment)
1572 $isminor: minor flag
1573 $iswatch: watch flag
1574 $section: section #
1575
1576 'PageContentSaveComplete': After an article has been updated
1577 $article: WikiPage modified
1578 $user: User performing the modification
1579 $content: New content, as a Content object
1580 $summary: Edit summary/comment
1581 $isMinor: Whether or not the edit was marked as minor
1582 $isWatch: (No longer used)
1583 $section: (No longer used)
1584 $flags: Flags passed to WikiPage::doEditContent()
1585 $revision: New Revision of the article
1586 $status: Status object about to be returned by doEditContent()
1587 $baseRevId: the rev ID (or false) this edit was based on
1588
1589 'PageHistoryBeforeList': When a history page list is about to be constructed.
1590 $article: the article that the history is loading for
1591
1592 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1593 $row: the revision row for this line
1594 $s: the string representing this parsed line
1595 $classes: array containing the <li> element classes
1596
1597 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1598 is constructed
1599 $pager: the pager
1600 $queryInfo: the query parameters
1601
1602 'PageRenderingHash': alter the parser cache option hash key
1603 A parser extension which depends on user options should install
1604 this hook and append its values to the key.
1605 $hash: reference to a hash key string which can be modified
1606
1607 'ParserAfterParse': Called from Parser::parse() just after the call to
1608 Parser::internalParse() returns
1609 $parser: parser object
1610 $text: text being parsed
1611 $stripState: stripState used (object)
1612
1613 'ParserAfterStrip': Same as ParserBeforeStrip
1614
1615 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1616 $parser: Parser object being used
1617 $text: text that'll be returned
1618
1619 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1620 $parser: Parser object
1621 $text: text to parse
1622 $stripState: StripState instance being used
1623
1624 'ParserBeforeStrip': Called at start of parsing time
1625 (no more strip, deprecated ?)
1626 $parser: parser object
1627 $text: text being parsed
1628 $stripState: stripState used (object)
1629
1630 'ParserBeforeTidy': called before tidy and custom tags replacements
1631 $parser: Parser object being used
1632 $text: actual text
1633
1634 'ParserClearState': called at the end of Parser::clearState()
1635 $parser: Parser object being cleared
1636
1637 'ParserCloned': called when the parser is cloned
1638 $parser: Newly-cloned Parser object
1639
1640 'ParserFirstCallInit': called when the parser initialises for the first time
1641 &$parser: Parser object being cleared
1642
1643 'ParserGetVariableValueSwitch': called when the parser need the value of a
1644 custom magic word
1645 $parser: Parser object
1646 $varCache: array to store the value in case of multiples calls of the
1647 same magic word
1648 $index: index (string) of the magic
1649 $ret: value of the magic word (the hook should set it)
1650 $frame: PPFrame object to use for expanding any template variables
1651
1652 'ParserGetVariableValueTs': use this to change the value of the time for the
1653 {{LOCAL...}} magic word
1654 $parser: Parser object
1655 $time: actual time (timestamp)
1656
1657 'ParserGetVariableValueVarCache': use this to change the value of the
1658 variable cache or return false to not use it
1659 $parser: Parser object
1660 $varCache: varaiable cache (array)
1661
1662 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1663 include comments about size of the text parsed
1664 $parser: Parser object
1665 $limitReport: text that will be included (without comment tags)
1666
1667 'ParserMakeImageParams': Called before the parser make an image link, use this
1668 to modify the parameters of the image.
1669 $title: title object representing the file
1670 $file: file object that will be used to create the image
1671 &$params: 2-D array of parameters
1672 $parser: Parser object that called the hook
1673
1674 'ParserSectionCreate': Called each time the parser creates a document section
1675 from wikitext. Use this to apply per-section modifications to HTML (like
1676 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
1677 can begin in one section and end in another. Make sure your code can handle
1678 that case gracefully. See the EditSectionClearerLink extension for an
1679 example.
1680 $parser: the calling Parser instance
1681 $section: the section number, zero-based, but section 0 is usually empty
1682 &$sectionContent: ref to the content of the section. modify this.
1683 $showEditLinks: boolean describing whether this section has an edit link
1684
1685 'ParserTestParser': called when creating a new instance of Parser in
1686 maintenance/parserTests.inc
1687 $parser: Parser object created
1688
1689 'ParserTestGlobals': Allows to define globals for parser tests.
1690 &$globals: Array with all the globals which should be set for parser tests.
1691 The arrays keys serve as the globals names, its values are the globals values.
1692
1693 'ParserTestTables': alter the list of tables to duplicate when parser tests
1694 are run. Use when page save hooks require the presence of custom tables
1695 to ensure that tests continue to run properly.
1696 &$tables: array of table names
1697
1698 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1699 my talk page, my contributions" etc).
1700 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1701 &$title: Title object representing the current page
1702
1703 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1704 &$user : User performing the action
1705 $action : Action being performed
1706 &$result : Whether or not the action should be prevented
1707 Change $result and return false to give a definitive answer, otherwise
1708 the built-in rate limiting checks are used, if enabled.
1709
1710 'PlaceNewSection': Override placement of new sections.
1711 $wikipage : WikiPage object
1712 $oldtext : the text of the article before editing
1713 $subject : subject of the new section
1714 &$text : text of the new section
1715 Return false and put the merged text into $text to override the default behavior.
1716
1717 'PreferencesGetLegend': Override the text used for the <legend> of a preferences section
1718 $form: the PreferencesForm object. This is a ContextSource as well
1719 $key: the section name
1720 &$legend: the legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
1721
1722 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1723 AJAX search suggestions. Put results into &$results outparam and return false.
1724 $ns : array of int namespace keys to search in
1725 $search : search term (not guaranteed to be conveniently normalized)
1726 $limit : maximum number of results to return
1727 &$results : out param: array of page names (strings)
1728
1729 'PrefsEmailAudit': called when user changes his email address
1730 $user: User (object) changing his email address
1731 $oldaddr: old email address (string)
1732 $newaddr: new email address (string)
1733
1734 'PrefsPasswordAudit': called when user changes his password
1735 $user: User (object) changing his passoword
1736 $newPass: new password
1737 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1738
1739 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1740 $article: the title being (un)protected
1741 $output: a string of the form HTML so far
1742
1743 'ProtectionForm::save': called when a protection form is submitted
1744 $article: the title being (un)protected
1745 $errorMsg: an html message string of an error or an array of message name and its parameters
1746
1747 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1748 $article: the page the form is shown for
1749 $out: OutputPage object
1750
1751 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1752 &$obj: RawPage object
1753 &$text: The text that's going to be the output
1754
1755 'RecentChange_save': called at the end of RecentChange::save()
1756 $recentChange: RecentChange object
1757
1758 'RedirectSpecialArticleRedirectParams': lets you alter the set of
1759 parameter names such as "oldid" that are preserved when using
1760 redirecting special pages such as Special:MyPage and Special:MyTalk.
1761 &$redirectParams: An array of parameters preserved by redirecting special pages.
1762
1763 'RequestContextCreateSkin': Called when RequestContext::getSkin creates a skin instance.
1764 Can be used by an extension override what skin is used in certain contexts.
1765 IContextSource $context: The RequestContext the skin is being created for.
1766 &$skin: A variable reference you may set a Skin instance or string key on to override the skin that will be used for the context.
1767
1768 'ResourceLoaderGetConfigVars': called at the end of
1769 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1770 configuration variables to JavaScript. Things that depend on the current
1771 page/request state must be added through MakeGlobalVariablesScript instead.
1772 &$vars: array( variable name => value )
1773
1774 'ResourceLoaderGetStartupModules': Run once the startup module is being generated. This allows you
1775 to add modules to the startup module. This hook should be used sparingly since any module added here
1776 will be loaded on all pages. This hook is useful if you want to make code available to module loader
1777 scripts.
1778
1779 'ResourceLoaderRegisterModules': Right before modules information is required, such as when responding to a resource
1780 loader request or generating HTML output.
1781 &$resourceLoader: ResourceLoader object
1782
1783 'ResourceLoaderTestModules': let you add new JavaScript testing modules. This is called after the addition of 'qunit' and MediaWiki testing resources.
1784 &testModules: array of JavaScript testing modules. The 'qunit' framework, included in core, is fed using tests/qunit/QUnitTestResources.php.
1785 &ResourceLoader object
1786 To add a new qunit module named 'myext.tests':
1787 testModules['qunit']['myext.tests'] = array(
1788 'script' => 'extension/myext/tests.js',
1789 'dependencies' => <any module dependency you might have>
1790 );
1791 For qunit framework, the mediawiki.tests.qunit.testrunner dependency will be added to any module.
1792
1793 'RevisionInsertComplete': called after a revision is inserted into the DB
1794 &$revision: the Revision
1795 $data: the data stored in old_text. The meaning depends on $flags: if external
1796 is set, it's the URL of the revision text in external storage; otherwise,
1797 it's the revision text itself. In either case, if gzip is set, the revision
1798 text is gzipped.
1799 $flags: a comma-delimited list of strings representing the options used. May
1800 include: utf8 (this will always be set for new revisions); gzip; external.
1801
1802 'SearchUpdate': Prior to search update completion
1803 $id : Page id
1804 $namespace : Page namespace
1805 $title : Page title
1806 $text : Current text being indexed
1807
1808 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1809 $allSearchTerms : Array of the search terms in all content languages
1810 &$titleResult : Outparam; the value to return. A Title object or null.
1811
1812 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1813 $term : Search term string
1814 &$title : Outparam; set to $title object and return false for a match
1815
1816 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1817 $term : Search term string
1818 &$title : Current Title object that is being returned (null if none found).
1819
1820 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1821 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1822 in the $searchEngine->namespaces array.
1823 $query : Original query.
1824 &$parsed : Resultant query with the prefixes stripped.
1825
1826 'SearchResultInitFromTitle': Set the revision used when displaying a page in
1827 search results.
1828 $title : Current Title object being displayed in search results.
1829 &$id: Revision ID (default is false, for latest)
1830
1831 'SearchableNamespaces': An option to modify which namespaces are searchable.
1832 &$arr : Array of namespaces ($nsId => $name) which will be used.
1833
1834 'SetupAfterCache': Called in Setup.php, after cache objects are set
1835
1836 'ShowMissingArticle': Called when generating the output for a non-existent page
1837 $article: The article object corresponding to the page
1838
1839 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views.
1840 DEPRECATED, use the ContentHandler facility to handle CSS and JavaScript!
1841 $text: Text being shown
1842 $title: Title of the custom script/stylesheet page
1843 $output: Current OutputPage object
1844
1845 'ShowSearchHitTitle': Customise display of search hit title/link.
1846 &$title: Title to link to
1847 &$text: Text to use for the link
1848 $result: The search result
1849 $terms: The search terms entered
1850 $page: The SpecialSearch object.
1851
1852 'ShowSearchHit': Customize display of search hit.
1853 $searchPage: The SpecialSearch instance.
1854 $result: The SearchResult to show
1855 $terms: Search terms, for highlighting
1856 &$link: HTML of link to the matching page. May be modified.
1857 &$redirect: HTML of redirect info. May be modified.
1858 &$section: HTML of matching section. May be modified.
1859 &$extract: HTML of content extract. May be modified.
1860 &$score: HTML of score. May be modified.
1861 &$size: HTML of page size. May be modified.
1862 &$date: HTML of of page modification date. May be modified.
1863 &$related: HTML of additional info for the matching page. May be modified.
1864 &$html: May be set to the full HTML that should be used to represent the search hit. Must include
1865 the <li> ... </li> tags. Will only be used if the hook function returned false.
1866
1867 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1868 &$siteNotice: HTML returned as the sitenotice
1869 $skin: Skin object
1870 Return true to allow the normal method of notice selection/rendering to work,
1871 or change the value of $siteNotice and return false to alter it.
1872
1873 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1874 &$siteNotice: HTML sitenotice
1875 $skin: Skin object
1876 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1877
1878 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1879 $skin: Skin object
1880 &$text: bottomScripts Text
1881 Append to $text to add additional text/scripts after the stock bottom scripts.
1882
1883 'SkinAfterContent': Allows extensions to add text after the page content and
1884 article metadata.
1885 &$data: (string) Text to be printed out directly (without parsing)
1886 $skin: Skin object
1887 This hook should work in all skins. Just set the &$data variable to the text
1888 you're going to add.
1889
1890 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1891 $skin: Skin object
1892 &$bar: Sidebar contents
1893 Modify $bar to add or modify sidebar portlets.
1894
1895 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1896 $title: displayed page title
1897 $type: 'normal' or 'history' for old/diff views
1898 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1899 &$link: overridable HTML link to be passed into the message as $1
1900 &$forContent: overridable flag if copyright footer is shown in content language.
1901
1902 'SkinGetPoweredBy'
1903 &$text: additional 'powered by' icons in HTML.
1904 Note: Modern skin does not use the MediaWiki icon but plain text instead
1905 $skin: Skin object
1906
1907 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1908 &$subpages: Subpage links HTML
1909 $skin: Skin object
1910 $out: OutputPage object
1911 If false is returned $subpages will be used instead of the HTML
1912 subPageSubtitle() generates.
1913 If true is returned, $subpages will be ignored and the rest of
1914 subPageSubtitle() will run.
1915
1916 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1917 "permanent link" tab
1918 $sktemplate: SkinTemplate object
1919 $nav_urls: array of tabs
1920
1921 Alter the structured navigation links in SkinTemplates, there are three of these hooks called in different spots.
1922 'SkinTemplateNavigation': Called on content pages after the tabs have been added but before before variants have been added
1923 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special tab is added but before variants have been added
1924 'SkinTemplateNavigation::Universal': Called on both content and special pages after variants have been added
1925 &$sktemplate: SkinTemplate object
1926 &$links: Structured navigation links
1927 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1928
1929 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1930 starts page output
1931 &$sktemplate: SkinTemplate object
1932 &$tpl: Template engine object
1933
1934 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1935 $sktemplate: SkinTemplate object
1936 $res: set to true to prevent active tabs
1937
1938 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1939 You can either create your own array, or alter the parameters for
1940 the normal one.
1941 &$sktemplate: The SkinTemplate instance.
1942 $title: Title instance for the page.
1943 $message: Visible label of tab.
1944 $selected: Whether this is a selected tab.
1945 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1946 &$classes: Array of CSS classes to apply.
1947 &$query: Query string to add to link.
1948 &$text: Link text.
1949 &$result: Complete assoc. array if you want to return true.
1950
1951 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1952 been rendered (useful for adding more)
1953 $sk: The QuickTemplate based skin template running the hook.
1954 $dummy: Called when SkinTemplateToolboxEnd is used from a BaseTemplate skin,
1955 extensions that add support for BaseTemplateToolbox should watch for this dummy
1956 parameter with "$dummy=false" in their code and return without echoing any html
1957 to avoid creating duplicate toolbox items.
1958
1959 'SoftwareInfo': Called by Special:Version for returning information about
1960 the software
1961 $software: The array of software in format 'name' => 'version'.
1962 See SpecialVersion::softwareInformation()
1963
1964 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1965 $id: User identifier
1966
1967 'SpecialListusersDefaultQuery': called right before the end of
1968 UsersPager::getDefaultQuery()
1969 $pager: The UsersPager instance
1970 $query: The query array to be returned
1971
1972 'SpecialListusersFormatRow': called right before the end of
1973 UsersPager::formatRow()
1974 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1975 $row: Database row object
1976
1977 'SpecialListusersHeader': called before closing the <fieldset> in
1978 UsersPager::getPageHeader()
1979 $pager: The UsersPager instance
1980 $out: The header HTML
1981
1982 'SpecialListusersHeaderForm': called before adding the submit button in
1983 UsersPager::getPageHeader()
1984 $pager: The UsersPager instance
1985 $out: The header HTML
1986
1987 'SpecialListusersQueryInfo': called right before the end of
1988 UsersPager::getQueryInfo()
1989 $pager: The UsersPager instance
1990 $query: The query array to be returned
1991
1992 'SpecialMovepageAfterMove': called after moving a page
1993 $movePage: MovePageForm object
1994 $oldTitle: old title (object)
1995 $newTitle: new title (object)
1996
1997 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1998 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1999 $opts: FormOptions object containing special page options
2000 &$conds: array of WHERE conditionals for query
2001 &tables: array of tables to be queried
2002 &$fields: array of columns to select
2003 &$join_conds: join conditions for the tables
2004
2005 'SpecialNewPagesFilters': called after building form options at NewPages
2006 $special: the special page object
2007 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
2008 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
2009
2010 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
2011 hook to remove a core special page
2012 $list: list (array) of core special pages
2013
2014 'SpecialPageAfterExecute': called after SpecialPage::execute
2015 $special: the SpecialPage object
2016 $subPage: the subpage string or null if no subpage was specified
2017
2018 'SpecialPageBeforeExecute': called before SpecialPage::execute
2019 $special: the SpecialPage object
2020 $subPage: the subpage string or null if no subpage was specified
2021
2022 'SpecialPasswordResetOnSubmit': when executing a form submission on Special:PasswordReset
2023 $users: array of User objects
2024 $data: array of data submitted by the user
2025 &$error: string, error code (message name) used to describe to error (out paramater).
2026 The hook needs to return false when setting this, otherwise it will have no effect.
2027
2028 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
2029 use this to change some selection criteria or substitute a different title
2030 &$randstr: The random number from wfRandom()
2031 &$isRedir: Boolean, whether to select a redirect or non-redirect
2032 &$namespaces: An array of namespace indexes to get the title from
2033 &$extra: An array of extra SQL statements
2034 &$title: If the hook returns false, a Title object to use instead of the
2035 result from the normal query
2036
2037 'SpecialRecentChangesFilters': called after building form options at RecentChanges
2038 $special: the special page object
2039 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
2040 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
2041
2042 'SpecialRecentChangesPanel': called when building form options in
2043 SpecialRecentChanges
2044 &$extraOpts: array of added items, to which can be added
2045 $opts: FormOptions for this request
2046
2047 'SpecialRecentChangesQuery': called when building sql query for
2048 SpecialRecentChanges and SpecialRecentChangesLinked
2049 &$conds: array of WHERE conditionals for query
2050 &$tables: array of tables to be queried
2051 &$join_conds: join conditions for the tables
2052 $opts: FormOptions for this request
2053 &$query_options: array of options for the database request
2054 &$select: Array of columns to select
2055
2056 'SpecialSearchCreateLink': called when making the message to create a page or
2057 go to the existing page
2058 $t: title object searched for
2059 &$params: an array of the default message name and page title (as parameter)
2060
2061 'SpecialSearchGo': called when user clicked the "Go"
2062 &$title: title object generated from the text entered by the user
2063 &$term: the search term entered by the user
2064
2065 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
2066 target doesn't exist
2067 &$title: title object generated from the text entered by the user
2068
2069 'SpecialSearchPowerBox': the equivalent of SpecialSearchProfileForm for
2070 the advanced form, a.k.a. power search box
2071 &$showSections: an array to add values with more options to
2072 $term: the search term (not a title object)
2073 $opts: an array of hidden options (containing 'redirs' and 'profile')
2074
2075 'SpecialSearchProfiles': allows modification of search profiles
2076 &$profiles: profiles, which can be modified.
2077
2078 'SpecialSearchProfileForm': allows modification of search profile forms
2079 $search: special page object
2080 &$form: String: form html
2081 $profile: String: current search profile
2082 $term: String: search term
2083 $opts: Array: key => value of hidden options for inclusion in custom forms
2084
2085 'SpecialSearchSetupEngine': allows passing custom data to search engine
2086 $search: special page object
2087 $profile: String: current search profile
2088 $engine: the search engine
2089
2090 'SpecialSearchResults': called before search result display when there
2091 are matches
2092 $term: string of search term
2093 &$titleMatches: empty or SearchResultSet object
2094 &$textMatches: empty or SearchResultSet object
2095
2096 'SpecialSearchNoResults': called before search result display when there are
2097 no matches
2098 $term: string of search term
2099
2100 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
2101 &$extraStats: Array to save the new stats
2102 ( $extraStats['<name of statistic>'] => <value>; )
2103
2104 'SpecialUploadComplete': Called after successfully uploading a file from
2105 Special:Upload
2106 $form: The SpecialUpload object
2107
2108 'SpecialVersionExtensionTypes': called when generating the extensions credits,
2109 use this to change the tables headers
2110 $extTypes: associative array of extensions types
2111
2112 'SpecialWatchlistFilters': called after building form options at Watchlist
2113 $special: the special page object
2114 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
2115 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
2116
2117 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
2118 &$conds: array of WHERE conditionals for query
2119 &$tables: array of tables to be queried
2120 &$join_conds: join conditions for the tables
2121 &$fields: array of query fields
2122
2123 'TestCanonicalRedirect': called when about to force a redirect to a canonical URL for a title when we have no other parameters on the URL. Gives a chance for extensions that alter page view behavior radically to abort that redirect or handle it manually.
2124 $request: WebRequest
2125 $title: Title of the currently found title obj
2126 $output: OutputPage object
2127
2128 'TitleArrayFromResult': called when creating an TitleArray object from a
2129 database result
2130 &$titleArray: set this to an object to override the default object returned
2131 $res: database result used to create the object
2132
2133 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
2134 that can be applied.
2135 $title: The title in question.
2136 &$types: The types of protection available.
2137
2138 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page
2139 $title: Title object that is being checked
2140 $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()
2141
2142 'TitleIsAlwaysKnown': Called when determining if a page exists.
2143 Allows overriding default behaviour for determining if a page exists.
2144 If $isKnown is kept as null, regular checks happen. If it's a boolean, this value is returned by the isKnown method.
2145 $title: Title object that is being checked
2146 &$isKnown: Boolean|null; whether MediaWiki currently thinks this page is known
2147
2148 'TitleIsMovable': Called when determining if it is possible to move a page.
2149 Note that this hook is not called for interwiki pages or pages in immovable namespaces: for these, isMovable() always returns false.
2150 $title: Title object that is being checked
2151 $result: Boolean; whether MediaWiki currently thinks this page is movable. Hooks may change this value to override the return value of Title::isMovable()
2152
2153 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
2154 be handled by seperate handler (via ArticleViewCustom)
2155 $title: Title object that is being checked
2156 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page. Hooks may change this value to override the return value of Title::isWikitextPage()
2157
2158 'TitleMoveComplete': after moving an article (title)
2159 $old: old title
2160 $nt: new title
2161 $user: user who did the move
2162 $pageid: database ID of the page that's been moved
2163 $redirid: database ID of the created redirect
2164
2165 'TitleReadWhitelist': called at the end of read permissions checks, just before
2166 adding the default error message if nothing allows the user to read the page.
2167 If a handler wants a title to *not* be whitelisted, it should also return false.
2168 $title: Title object being checked against
2169 $user: Current user object
2170 &$whitelisted: Boolean value of whether this title is whitelisted
2171
2172 'UndeleteForm::showHistory': called in UndeleteForm::showHistory, after a
2173 PageArchive object has been created but before any further processing is done.
2174 &$archive: PageArchive object
2175 $title: Title object of the page that we're viewing
2176
2177 'UndeleteForm::showRevision': called in UndeleteForm::showRevision, after a
2178 PageArchive object has been created but before any further processing is done.
2179 &$archive: PageArchive object
2180 $title: Title object of the page that we're viewing
2181
2182 'UndeleteForm::undelete': called un UndeleteForm::undelete, after checking that
2183 the site is not in read-only mode, that the Title object is not null and after
2184 a PageArchive object has been constructed but before performing any further
2185 processing.
2186 &$archive: PageArchive object
2187 $title: Title object of the page that we're about to undelete
2188
2189 'UndeleteShowRevision': called when showing a revision in Special:Undelete
2190 $title: title object related to the revision
2191 $rev: revision (object) that will be viewed
2192
2193 'UnknownAction': An unknown "action" has occured (useful for defining
2194 your own actions)
2195 $action: action name
2196 $article: article "acted on"
2197
2198 'UnitTestsList': Called when building a list of files with PHPUnit tests
2199 &$files: list of files
2200
2201 'UnwatchArticle': before a watch is removed from an article
2202 $user: user watching
2203 $page: WikiPage object to be removed
2204
2205 'UnwatchArticleComplete': after a watch is removed from an article
2206 $user: user that watched
2207 $page: WikiPage object that was watched
2208
2209 'UploadForm:initial': before the upload form is generated
2210 $form: UploadForm object
2211 You might set the member-variables $uploadFormTextTop and
2212 $uploadFormTextAfterSummary to inject text (HTML) either before
2213 or after the editform.
2214
2215 'UploadForm:BeforeProcessing': at the beginning of processUpload()
2216 $form: UploadForm object
2217 Lets you poke at member variables like $mUploadDescription before the
2218 file is saved.
2219 Do not use this hook to break upload processing. This will return the user to
2220 a blank form with no error message; use UploadVerification and
2221 UploadVerifyFile instead
2222
2223 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
2224 $type: (string) the requested upload type
2225 &$className: the class name of the Upload instance to be created
2226
2227 'UploadComplete': when Upload completes an upload
2228 &$upload: an UploadBase child instance
2229
2230 'UploadFormInitDescriptor': after the descriptor for the upload form as been
2231 assembled
2232 $descriptor: (array) the HTMLForm descriptor
2233
2234 'UploadFormSourceDescriptors': after the standard source inputs have been
2235 added to the descriptor
2236 $descriptor: (array) the HTMLForm descriptor
2237
2238 'UploadVerification': additional chances to reject an uploaded file. Consider
2239 using UploadVerifyFile instead.
2240 string $saveName: destination file name
2241 string $tempName: filesystem path to the temporary file for checks
2242 string &$error: output: message key for message to show if upload canceled
2243 by returning false. May also be an array, where the first element
2244 is the message key and the remaining elements are used as parameters to
2245 the message.
2246
2247 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
2248 in most cases over UploadVerification.
2249 object $upload: an instance of UploadBase, with all info about the upload
2250 string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
2251 will typically only apply for specific mime types.
2252 object &$error: output: true if the file is valid. Otherwise, an indexed array
2253 representing the problem with the file, where the first element
2254 is the message key and the remaining elements are used as parameters to
2255 the message.
2256
2257 'UploadComplete': Upon completion of a file upload
2258 $uploadBase: UploadBase (or subclass) object. File can be accessed by
2259 $uploadBase->getLocalFile().
2260
2261 'User::mailPasswordInternal': before creation and mailing of a user's new
2262 temporary password
2263 $user: the user who sent the message out
2264 $ip: IP of the user who sent the message out
2265 $u: the account whose new password will be set
2266
2267 'UserAddGroup': called when adding a group; return false to override
2268 stock group addition.
2269 $user: the user object that is to have a group added
2270 &$group: the group to add, can be modified
2271
2272 'UserArrayFromResult': called when creating an UserArray object from a
2273 database result
2274 &$userArray: set this to an object to override the default object returned
2275 $res: database result used to create the object
2276
2277 'userCan': To interrupt/advise the "user can do X to Y article" check.
2278 If you want to display an error message, try getUserPermissionsErrors.
2279 $title: Title object being checked against
2280 $user : Current user object
2281 $action: Action being checked
2282 $result: Pointer to result returned if hook returns false. If null is returned,
2283 userCan checks are continued by internal code.
2284
2285 'UserCanSendEmail': To override User::canSendEmail() permission check
2286 $user: User (object) whose permission is being checked
2287 &$canSend: bool set on input, can override on output
2288
2289 'UserClearNewTalkNotification': called when clearing the
2290 "You have new messages!" message, return false to not delete it
2291 $user: User (object) that'll clear the message
2292
2293 'UserComparePasswords': called when checking passwords, return false to
2294 override the default password checks
2295 &$hash: String of the password hash (from the database)
2296 &$password: String of the plaintext password the user entered
2297 &$userId: Integer of the user's ID or Boolean false if the user ID was not
2298 supplied
2299 &$result: If the hook returns false, this Boolean value will be checked to
2300 determine if the password was valid
2301
2302 'UserCreateForm': change to manipulate the login form
2303 $template: SimpleTemplate instance for the form
2304
2305 'UserCryptPassword': called when hashing a password, return false to implement
2306 your own hashing method
2307 &$password: String of the plaintext password to encrypt
2308 &$salt: String of the password salt or Boolean false if no salt is provided
2309 &$wgPasswordSalt: Boolean of whether the salt is used in the default
2310 hashing method
2311 &$hash: If the hook returns false, this String will be used as the hash
2312
2313 'UserEffectiveGroups': Called in User::getEffectiveGroups()
2314 $user: User to get groups for
2315 &$groups: Current effective groups
2316
2317 'UserGetAllRights': after calculating a list of all available rights
2318 &$rights: Array of rights, which may be added to.
2319
2320 'UserGetDefaultOptions': after fetching the core default, this hook is ran
2321 right before returning the options to the caller. WARNING: this hook is
2322 called for every call to User::getDefaultOptions(), which means it's
2323 potentially called dozens or hundreds of times. You may want to cache
2324 the results of non-trivial operations in your hook function for this reason.
2325 &$defaultOptions: Array of preference keys and their default values.
2326
2327 'UserGetEmail': called when getting an user email address
2328 $user: User object
2329 &$email: email, change this to override local email
2330
2331 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
2332 email authentification
2333 $user: User object
2334 &$timestamp: timestamp, change this to override local email authentification
2335 timestamp
2336
2337 'UserGetImplicitGroups': Called in User::getImplicitGroups()
2338 &$groups: List of implicit (automatically-assigned) groups
2339
2340 'UserGetLanguageObject': Called when getting user's interface language object
2341 $user: User object
2342 &$code: Langauge code that will be used to create the object
2343
2344 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
2345 &$reservedUsernames: $wgReservedUsernames
2346
2347 'UserGetRights': Called in User::getRights()
2348 $user: User to get rights for
2349 &$rights: Current rights
2350
2351 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
2352 exemptions).
2353 $user: User in question
2354 $title: Title of the page in question
2355 &$blocked: Out-param, whether or not the user is blocked from that page.
2356 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
2357 own user talk pages.
2358
2359 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2360 &$user: User object
2361 $ip: User's IP address
2362 &$blocked: Whether the user is blocked, to be modified by the hook
2363
2364 'UserLoadAfterLoadFromSession': called to authenticate users on
2365 external/environmental means; occurs after session is loaded
2366 $user: user object being loaded
2367
2368 'UserLoadDefaults': called when loading a default user
2369 $user: user object
2370 $name: user name
2371
2372 'UserLoadFromDatabase': called when loading a user from the database
2373 $user: user object
2374 &$s: database query object
2375
2376 'UserLoadFromSession': called to authenticate users on external/environmental
2377 means; occurs before session is loaded
2378 $user: user object being loaded
2379 &$result: set this to a boolean value to abort the normal authentification
2380 process
2381
2382 'UserLoadOptions': when user options/preferences are being loaded from
2383 the database.
2384 $user: User object
2385 &$options: Options, can be modified.
2386
2387 'UserLoginComplete': after a user has logged in
2388 $user: the user object that was created on login
2389 $inject_html: Any HTML to inject after the "logged in" message.
2390
2391 'UserLoginForm': change to manipulate the login form
2392 $template: SimpleTemplate instance for the form
2393
2394 'UserLogout': before a user logs out
2395 $user: the user object that is about to be logged out
2396
2397 'UserLogoutComplete': after a user has logged out
2398 $user: the user object _after_ logout (won't have name, ID, etc.)
2399 $inject_html: Any HTML to inject after the "logged out" message.
2400 $oldName: name of the user before logout (string)
2401
2402 'UserRemoveGroup': called when removing a group; return false to override
2403 stock group removal.
2404 $user: the user object that is to have a group removed
2405 &$group: the group to be removed, can be modified
2406
2407 'UserRights': After a user's group memberships are changed
2408 $user : User object that was changed
2409 $add : Array of strings corresponding to groups added
2410 $remove: Array of strings corresponding to groups removed
2411
2412 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
2413 message(s)
2414 $user: user retrieving new talks messages
2415 $talks: array of new talks page(s)
2416
2417 'UserSaveSettings': called when saving user settings
2418 $user: User object
2419
2420 'UserSaveOptions': Called just before saving user preferences/options.
2421 $user: User object
2422 &$options: Options, modifiable
2423
2424 'UserSetCookies': called when setting user cookies
2425 $user: User object
2426 &$session: session array, will be added to $_SESSION
2427 &$cookies: cookies array mapping cookie name to its value
2428
2429 'UserSetEmail': called when changing user email address
2430 $user: User object
2431 &$email: new email, change this to override new email address
2432
2433 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
2434 of email authentification
2435 $user: User object
2436 &$timestamp: new timestamp, change this to override local email
2437 authentification timestamp
2438
2439 'UserToolLinksEdit': Called when generating a list of user tool links, eg "Foobar (Talk | Contribs | Block)"
2440 $userId: User id of the current user
2441 $userText: User name of the current user
2442 &$items: Array of user tool links as HTML fragments
2443
2444 'WantedPages::getQueryInfo': called in WantedPagesPage::getQueryInfo(), can be
2445 used to alter the SQL query which gets the list of wanted pages
2446 &$wantedPages: WantedPagesPage object
2447 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2448
2449 'WatchArticle': before a watch is added to an article
2450 $user: user that will watch
2451 $page: WikiPage object to be watched
2452
2453 'WatchArticleComplete': after a watch is added to an article
2454 $user: user that watched
2455 $page: WikiPage object watched
2456
2457 'WatchlistEditorBuildRemoveLine': when building remove lines in
2458 Special:Watchlist/edit
2459 &$tools: array of extra links
2460 $title: Title object
2461 $redirect: whether the page is a redirect
2462 $skin: Skin object
2463
2464 'WebRequestPathInfoRouter': While building the PathRouter to parse the REQUEST_URI.
2465 $router: The PathRouter instance
2466
2467 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2468 dumps
2469 One, and only one hook should set this, and return false.
2470 &$tables: Database tables to use in the SELECT query
2471 &$opts: Options to use for the query
2472 &$join: Join conditions
2473
2474 'WikiPageDeletionUpdates': manipulate the list of DataUpdates to be applied when
2475 a page is deleted. Called in WikiPage::getDeletionUpdates().
2476 Note that updates specific to a content model should be provided by the
2477 respective Content's getDeletionUpdates() method.
2478 $page: the WikiPage
2479 $content: the Content to generate updates for
2480 &$updates: the array of DataUpdate objects. Hook function may want to add to it.
2481
2482 'wfShellWikiCmd': Called when generating a shell-escaped command line
2483 string to run a MediaWiki cli script.
2484 &$script: MediaWiki cli script path
2485 &$parameters: Array of arguments and options to the script
2486 &$options: Associative array of options, may contain the 'php' and 'wrapper'
2487 keys
2488
2489 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
2490 query pages to be updated with maintenance/updateSpecialPages.php
2491 $query: $wgQueryPages itself
2492
2493 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
2494 metadata to be added.
2495 $obj: The XmlDumpWriter object.
2496 &$out: The output string.
2497 $row: The database row for the page.
2498 $title: The title of the page.
2499
2500 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
2501 metadata.
2502 $obj: The XmlDumpWriter object.
2503 &$out: The text being output.
2504 $row: The database row for the revision.
2505 $text: The revision text.
2506
2507 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used to add
2508 additional tags to extract.
2509 &$items: Array containing information on which items to extract. See XMPInfo for details on the format.
2510
2511 'XMPGetResults': Called just before returning the results array of parsing xmp data. Can be
2512 used to post-process the results.
2513 &$data: Array of metadata sections (such as $data['xmp-general']) each section is an array of
2514 metadata tags returned (each tag is either a value, or an array of values).
2515
2516 More hooks might be available but undocumented, you can execute
2517 ./maintenance/findhooks.php to find hidden one.