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