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