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