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