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