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