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