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