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