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