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