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