Add TitleIsMovable hook so extensions can create new namespaces in which pages can...
[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 'LanguageGetMagic': DEPRECATED, use $magicWords in a file listed in
1093 $wgExtensionMessagesFiles instead.
1094 Use this to define synonyms of magic words depending of the language
1095 $magicExtensions: associative array of magic words synonyms
1096 $lang: laguage code (string)
1097
1098 'LanguageGetSpecialPageAliases': DEPRECATED, use $specialPageAliases in a file
1099 listed in $wgExtensionMessagesFiles instead.
1100 Use to define aliases of special pages names depending of the language
1101 $specialPageAliases: associative array of magic words synonyms
1102 $lang: laguage code (string)
1103
1104 'LanguageGetTranslatedLanguageNames': Provide translated language names.
1105 &$names: array of language code => language name
1106 $code language of the preferred translations
1107
1108 'LinkBegin': Used when generating internal and interwiki links in
1109 Linker::link(), before processing starts. Return false to skip default proces-
1110 sing and return $ret. See documentation for Linker::link() for details on the
1111 expected meanings of parameters.
1112 $skin: the Skin object
1113 $target: the Title that the link is pointing to
1114 &$html: the contents that the <a> tag should have (raw HTML); null means "de-
1115 fault"
1116 &$customAttribs: the HTML attributes that the <a> tag should have, in associa-
1117 tive array form, with keys and values unescaped. Should be merged with de-
1118 fault values, with a value of false meaning to suppress the attribute.
1119 &$query: the query string to add to the generated URL (the bit after the "?"),
1120 in associative array form, with keys and values unescaped.
1121 &$options: array of options. Can include 'known', 'broken', 'noclasses'.
1122 &$ret: the value to return if your hook returns false.
1123
1124 'LinkEnd': Used when generating internal and interwiki links in Linker::link(),
1125 just before the function returns a value. If you return true, an <a> element
1126 with HTML attributes $attribs and contents $html will be returned. If you re-
1127 turn false, $ret will be returned.
1128 $skin: the Skin object
1129 $target: the Title object that the link is pointing to
1130 $options: the options. Will always include either 'known' or 'broken', and may
1131 include 'noclasses'.
1132 &$html: the final (raw HTML) contents of the <a> tag, after processing.
1133 &$attribs: the final HTML attributes of the <a> tag, after processing, in asso-
1134 ciative array form.
1135 &$ret: the value to return if your hook returns false.
1136
1137 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just
1138 before the return
1139 &$url: the image url
1140 &$alt: the image's alt text
1141 &$img: the new image HTML (if returning false)
1142
1143 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just
1144 before the return
1145 &$url: the link url
1146 &$text: the link text
1147 &$link: the new link HTML (if returning false)
1148 &$attribs: the attributes to be applied.
1149 $linkType: The external link type
1150
1151 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the
1152 actual update
1153 &$linksUpdate: the LinksUpdate object
1154
1155 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has
1156 completed
1157 &$linksUpdate: the LinksUpdate object
1158
1159 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
1160 &$linksUpdate: the LinksUpdate object
1161
1162 'ListDefinedTags': When trying to find all defined tags.
1163 &$tags: The list of tags.
1164
1165 'LoadExtensionSchemaUpdates': called during database installation and updates
1166 &updater: A DatabaseUpdater subclass
1167
1168 'LocalFile::getHistory': called before file history query performed
1169 $file: the file
1170 $tables: tables
1171 $fields: select fields
1172 $conds: conditions
1173 $opts: query options
1174 $join_conds: JOIN conditions
1175
1176 'LocalisationCacheRecache': Called when loading the localisation data into cache
1177 $cache: The LocalisationCache object
1178 $code: language code
1179 &$alldata: The localisation data from core and extensions
1180
1181 'LoginAuthenticateAudit': a login attempt for a valid user account either
1182 succeeded or failed. No return data is accepted; this hook is for auditing only.
1183 $user: the User object being authenticated against
1184 $password: the password being submitted and found wanting
1185 $retval: a LoginForm class constant with authenticateUserData() return
1186 value (SUCCESS, WRONG_PASS, etc)
1187
1188 'LogLine': Processes a single log entry on Special:Log
1189 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to
1190 logging.log_type database field.
1191 $log_action: string for the type of log action (e.g. 'delete', 'block',
1192 'create2'). Corresponds to logging.log_action database field.
1193 $title: Title object that corresponds to logging.log_namespace and
1194 logging.log_title database fields.
1195 $paramArray: Array of parameters that corresponds to logging.log_params field.
1196 Note that only $paramArray[0] appears to contain anything.
1197 &$comment: string that corresponds to logging.log_comment database field, and
1198 which is displayed in the UI.
1199 &$revert: string that is displayed in the UI, similar to $comment.
1200 $time: timestamp of the log entry (added in 1.12)
1201
1202 'MaintenanceRefreshLinksInit': before executing the refreshLinks.php maintenance script
1203 $refreshLinks: RefreshLinks object
1204
1205 'MagicWordMagicWords': When defining new magic word.
1206 DEPRECATED: use $magicWords in a file listed in
1207 $wgExtensionMessagesFiles instead.
1208 $magicWords: array of strings
1209
1210 'MagicWordwgVariableIDs': When definig new magic words IDs.
1211 $variableIDs: array of strings
1212
1213 'MakeGlobalVariablesScript': called right before Skin::makeVariablesScript
1214 is executed. Ideally, this hook should only be used to add variables that
1215 depend on the current page/request; static configuration should be added
1216 through ResourceLoaderGetConfigVars instead.
1217 &$vars: variable (or multiple variables) to be added into the output
1218 of Skin::makeVariablesScript
1219
1220 'MarkPatrolled': before an edit is marked patrolled
1221 $rcid: ID of the revision to be marked patrolled
1222 $user: the user (object) marking the revision as patrolled
1223 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1224 needs to be a sysop in order to mark an edit patrolled
1225
1226 'MarkPatrolledComplete': after an edit is marked patrolled
1227 $rcid: ID of the revision marked as patrolled
1228 $user: user (object) who marked the edit patrolled
1229 $wcOnlySysopsCanPatrol: config setting indicating whether the user
1230 must be a sysop to patrol the edit
1231
1232 'MediaWikiPerformAction': Override MediaWiki::performAction().
1233 Use this to do something completely different, after the basic
1234 globals have been set up, but before ordinary actions take place.
1235 $output: $wgOut
1236 $article: $wgArticle
1237 $title: $wgTitle
1238 $user: $wgUser
1239 $request: $wgRequest
1240 $mediaWiki: The $mediawiki object
1241
1242 'MessagesPreLoad': When loading a message from the database
1243 $title: title of the message (string)
1244 $message: value (string), change it to the message you want to define
1245
1246 'MessageCacheReplace': When a message page is changed.
1247 Useful for updating caches.
1248 $title: name of the page changed.
1249 $text: new contents of the page.
1250
1251 'ModifyExportQuery': Modify the query used by the exporter.
1252 $db: The database object to be queried.
1253 &$tables: Tables in the query.
1254 &$conds: Conditions in the query.
1255 &$opts: Options for the query.
1256 &$join_conds: Join conditions for the query.
1257
1258 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have
1259 been rendered (useful for adding more)
1260 Note: this is only run for the Monobook skin. This hook is deprecated and
1261 may be removed in the future. To add items to the toolbox you should use
1262 the SkinTemplateToolboxEnd hook instead, which works for all
1263 "SkinTemplate"-type skins.
1264 $tools: array of tools
1265
1266 'BaseTemplateToolbox': Called by BaseTemplate when building the $toolbox array
1267 and returning it for the skin to output. You can add items to the toolbox while
1268 still letting the skin make final decisions on skin-specific markup conventions
1269 using this hook.
1270 &$sk: The BaseTemplate base skin template
1271 &$toolbox: An array of toolbox items, see BaseTemplate::getToolbox and
1272 BaseTemplate::makeListItem for details on the format of individual
1273 items inside of this array
1274
1275 'NewRevisionFromEditComplete': called when a revision was inserted
1276 due to an edit
1277 $article: the WikiPage edited
1278 $rev: the new revision
1279 $baseID: the revision ID this was based off, if any
1280 $user: the editing user
1281
1282 'NormalizeMessageKey': Called before the software gets the text of a message
1283 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets
1284 displayed
1285 &$key: the message being looked up. Change this to something else to change
1286 what message gets displayed (string)
1287 &$useDB: whether or not to look up the message in the database (bool)
1288 &$langCode: the language code to get the message for (string) - or -
1289 whether to use the content language (true) or site language (false) (bool)
1290 &$transform: whether or not to expand variables and templates
1291 in the message (bool)
1292
1293 'OldChangesListRecentChangesLine': Customize entire Recent Changes line.
1294 &$changeslist: The OldChangesList instance.
1295 &$s: HTML of the form "<li>...</li>" containing one RC entry.
1296 &$rc: The RecentChange object.
1297
1298 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
1299 Hooks can alter or append to the array of URLs for search & suggestion formats.
1300 &$urls: array of associative arrays with Url element attributes
1301
1302 'OtherBlockLogLink': Get links to the block log from extensions which blocks
1303 users and/or IP addresses too
1304 $otherBlockLink: An array with links to other block logs
1305 $ip: The requested IP address or username
1306
1307 'OutputPageBeforeHTML': a page has been processed by the parser and
1308 the resulting HTML is about to be displayed.
1309 $parserOutput: the parserOutput (object) that corresponds to the page
1310 $text: the text that will be displayed, in HTML (string)
1311
1312 'OutputPageBodyAttributes': called when OutputPage::headElement is creating the body
1313 tag to allow for extensions to add attributes to the body of the page they might
1314 need. Or to allow building extensions to add body classes that aren't of high
1315 enough demand to be included in core.
1316 $out: The OutputPage which called the hook, can be used to get the real title
1317 $sk: The Skin that called OutputPage::headElement
1318 &$bodyAttrs: An array of attributes for the body tag passed to Html::openElement
1319
1320 'OutputPageCheckLastModified': when checking if the page has been modified
1321 since the last visit
1322 &$modifiedTimes: array of timestamps.
1323 The following keys are set: page, user, epoch
1324
1325 'OutputPageParserOutput': after adding a parserOutput to $wgOut
1326 $out: OutputPage instance (object)
1327 $parserOutput: parserOutput instance being added in $out
1328
1329 'OutputPageMakeCategoryLinks': links are about to be generated for the page's
1330 categories. Implementations should return false if they generate the category
1331 links, so the default link generation is skipped.
1332 $out: OutputPage instance (object)
1333 $categories: associative array, keys are category names, values are category
1334 types ("normal" or "hidden")
1335 $links: array, intended to hold the result. Must be an associative array with
1336 category types as keys and arrays of HTML links as values.
1337
1338 'PageContentLanguage': allows changing the language in which the content of
1339 a page is written. Defaults to the wiki content language ($wgContLang).
1340 $title: Title object
1341 &$pageLang: the page content language (either an object or a language code)
1342 $wgLang: the user language
1343
1344 'PageHistoryBeforeList': When a history page list is about to be constructed.
1345 $article: the article that the history is loading for
1346
1347 'PageHistoryLineEnding' : right before the end <li> is added to a history line
1348 $row: the revision row for this line
1349 $s: the string representing this parsed line
1350 $classes: array containing the <li> element classes
1351
1352 'PageHistoryPager::getQueryInfo': when a history pager query parameter set
1353 is constructed
1354 $pager: the pager
1355 $queryInfo: the query parameters
1356
1357 'PageRenderingHash': alter the parser cache option hash key
1358 A parser extension which depends on user options should install
1359 this hook and append its values to the key.
1360 $hash: reference to a hash key string which can be modified
1361
1362 'ParserAfterStrip': Same as ParserBeforeStrip
1363
1364 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
1365 $parser: Parser object being used
1366 $text: text that'll be returned
1367
1368 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
1369 $parser: Parser object
1370 $text: text to parse
1371 $stripState: StripState instance being used
1372
1373 'ParserBeforeStrip': Called at start of parsing time
1374 (no more strip, deprecated ?)
1375 $parser: parser object
1376 $text: text being parsed
1377 $stripState: stripState used (object)
1378
1379 'ParserBeforeTidy': called before tidy and custom tags replacements
1380 $parser: Parser object being used
1381 $text: actual text
1382
1383 'ParserClearState': called at the end of Parser::clearState()
1384 $parser: Parser object being cleared
1385
1386 'ParserFirstCallInit': called when the parser initialises for the first time
1387 &$parser: Parser object being cleared
1388
1389 'ParserGetVariableValueSwitch': called when the parser need the value of a
1390 custom magic word
1391 $parser: Parser object
1392 $varCache: array to store the value in case of multiples calls of the
1393 same magic word
1394 $index: index (string) of the magic
1395 $ret: value of the magic word (the hook should set it)
1396 $frame: PPFrame object to use for expanding any template variables
1397
1398 'ParserGetVariableValueTs': use this to change the value of the time for the
1399 {{LOCAL...}} magic word
1400 $parser: Parser object
1401 $time: actual time (timestamp)
1402
1403 'ParserGetVariableValueVarCache': use this to change the value of the
1404 variable cache or return false to not use it
1405 $parser: Parser object
1406 $varCache: varaiable cache (array)
1407
1408 'ParserLimitReport': called at the end of Parser:parse() when the parser will
1409 include comments about size of the text parsed
1410 $parser: Parser object
1411 $limitReport: text that will be included (without comment tags)
1412
1413 'ParserMakeImageParams': Called before the parser make an image link, use this
1414 to modify the parameters of the image.
1415 $title: title object representing the file
1416 $file: file object that will be used to create the image
1417 &$params: 2-D array of parameters
1418
1419 'ParserSectionCreate': Called each time the parser creates a document section
1420 from wikitext. Use this to apply per-section modifications to HTML (like
1421 wrapping the section in a DIV). Caveat: DIVs are valid wikitext, and a DIV
1422 can begin in one section and end in another. Make sure your code can handle
1423 that case gracefully. See the EditSectionClearerLink extension for an
1424 example.
1425 $parser: the calling Parser instance
1426 $section: the section number, zero-based, but section 0 is usually empty
1427 &$sectionContent: ref to the content of the section. modify this.
1428 $showEditLinks: boolean describing whether this section has an edit link
1429
1430 'ParserTestParser': called when creating a new instance of Parser in
1431 maintenance/parserTests.inc
1432 $parser: Parser object created
1433
1434 'ParserTestTables': alter the list of tables to duplicate when parser tests
1435 are run. Use when page save hooks require the presence of custom tables
1436 to ensure that tests continue to run properly.
1437 &$tables: array of table names
1438
1439 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
1440 my talk page, my contributions" etc).
1441
1442 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
1443 &$title: Title object representing the current page
1444
1445 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
1446 &$user : User performing the action
1447 $action : Action being performed
1448 &$result : Whether or not the action should be prevented
1449 Change $result and return false to give a definitive answer, otherwise
1450 the built-in rate limiting checks are used, if enabled.
1451
1452 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
1453 AJAX search suggestions. Put results into &$results outparam and return false.
1454 $ns : array of int namespace keys to search in
1455 $search : search term (not guaranteed to be conveniently normalized)
1456 $limit : maximum number of results to return
1457 &$results : out param: array of page names (strings)
1458
1459 'PrefsEmailAudit': called when user changes his email address
1460 $user: User (object) changing his email address
1461 $oldaddr: old email address (string)
1462 $newaddr: new email address (string)
1463
1464 'PrefsPasswordAudit': called when user changes his password
1465 $user: User (object) changing his passoword
1466 $newPass: new password
1467 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1468
1469 'ProtectionForm::buildForm': called after all protection type fieldsets are made in the form
1470 $article: the title being (un)protected
1471 $output: a string of the form HTML so far
1472
1473 'ProtectionForm::save': called when a protection form is submitted
1474 $article: the title being (un)protected
1475 $errorMsg: an html message string of an error
1476
1477 'ProtectionForm::showLogExtract': called after the protection log extract is shown
1478 $article: the page the form is shown for
1479 $out: OutputPage object
1480
1481 'ResourceLoaderRegisterModules': Right before modules information is required, such as when responding to a resource
1482 loader request or generating HTML output.
1483 &$resourceLoader: ResourceLoader object
1484
1485 'ResourceLoaderGetStartupModules': Run once the startup module is being generated. This allows you
1486 to add modules to the startup module. This hook should be used sparingly since any module added here
1487 will be loaded on all pages. This hook is useful if you want to make code available to module loader
1488 scripts.
1489
1490 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1491 &$obj: RawPage object
1492 &$text: The text that's going to be the output
1493
1494 'RecentChange_save': called at the end of RecentChange::save()
1495 $recentChange: RecentChange object
1496
1497 'ResourceLoaderGetConfigVars': called at the end of
1498 ResourceLoaderStartUpModule::getConfig(). Use this to export static
1499 configuration variables to JavaScript. Things that depend on the current
1500 page/request state must be added through MakeGlobalVariablesScript instead.
1501 &$vars: array( variable name => value )
1502
1503 'RevisionInsertComplete': called after a revision is inserted into the DB
1504 &$revision: the Revision
1505 $data: the data stored in old_text. The meaning depends on $flags: if external
1506 is set, it's the URL of the revision text in external storage; otherwise,
1507 it's the revision text itself. In either case, if gzip is set, the revision
1508 text is gzipped.
1509 $flags: a comma-delimited list of strings representing the options used. May
1510 include: utf8 (this will always be set for new revisions); gzip; external.
1511
1512 'SearchUpdate': Prior to search update completion
1513 $id : Page id
1514 $namespace : Page namespace
1515 $title : Page title
1516 $text : Current text being indexed
1517
1518 'SearchGetNearMatchBefore': Perform exact-title-matches in "go" searches before the normal operations
1519 $allSearchTerms : Array of the search terms in all content languages
1520 &$titleResult : Outparam; the value to return. A Title object or null.
1521
1522 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches if nothing was found
1523 $term : Search term string
1524 &$title : Outparam; set to $title object and return false for a match
1525
1526 'SearchGetNearMatchComplete': A chance to modify exact-title-matches in "go" searches
1527 $term : Search term string
1528 &$title : Current Title object that is being returned (null if none found).
1529
1530 'SearchEngineReplacePrefixesComplete': Run after SearchEngine::replacePrefixes().
1531 $searchEngine : The SearchEngine object. Users of this hooks will be interested
1532 in the $searchEngine->namespaces array.
1533 $query : Original query.
1534 &$parsed : Resultant query with the prefixes stripped.
1535
1536 'SearchableNamespaces': An option to modify which namespaces are searchable.
1537 &$arr : Array of namespaces ($nsId => $name) which will be used.
1538
1539 'SetupAfterCache': Called in Setup.php, after cache objects are set
1540
1541 'ShowMissingArticle': Called when generating the output for a non-existent page
1542 $article: The article object corresponding to the page
1543
1544 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1545 $text: Text being shown
1546 $title: Title of the custom script/stylesheet page
1547 $output: Current OutputPage object
1548
1549 'ShowSearchHitTitle': Customise display of search hit title/link.
1550 &$title: Title to link to
1551 &$text: Text to use for the link
1552 $result: The search result
1553 $terms: The search terms entered
1554 $page: The SpecialSearch object.
1555
1556 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1557 &$siteNotice: HTML returned as the sitenotice
1558 $skin: Skin object
1559 Return true to allow the normal method of notice selection/rendering to work,
1560 or change the value of $siteNotice and return false to alter it.
1561
1562 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1563 &$siteNotice: HTML sitenotice
1564 $skin: Skin object
1565 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1566
1567 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1568 $skin: Skin object
1569 &$text: bottomScripts Text
1570 Append to $text to add additional text/scripts after the stock bottom scripts.
1571
1572 'SkinAfterContent': Allows extensions to add text after the page content and
1573 article metadata.
1574 &$data: (string) Text to be printed out directly (without parsing)
1575 $skin: Skin object
1576 This hook should work in all skins. Just set the &$data variable to the text
1577 you're going to add.
1578
1579 'SkinBuildSidebar': At the end of Skin::buildSidebar()
1580 $skin: Skin object
1581 &$bar: Sidebar contents
1582 Modify $bar to add or modify sidebar portlets.
1583
1584 'SkinCopyrightFooter': Allow for site and per-namespace customization of copyright notice.
1585 $title: displayed page title
1586 $type: 'normal' or 'history' for old/diff views
1587 &$msg: overridable message; usually 'copyright' or 'history_copyright'. This message must be in HTML format, not wikitext!
1588 &$link: overridable HTML link to be passed into the message as $1
1589 &$forContent: overridable flag if copyright footer is shown in content language.
1590
1591 'SkinGetPoweredBy'
1592 &$text: additional 'powered by' icons in HTML.
1593 Note: Modern skin does not use the MediaWiki icon but plain text instead
1594 $skin: Skin object
1595
1596 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1597 &$subpages: Subpage links HTML
1598 $skin: Skin object
1599 $out: OutputPage object
1600 If false is returned $subpages will be used instead of the HTML
1601 subPageSubtitle() generates.
1602 If true is returned, $subpages will be ignored and the rest of
1603 subPageSubtitle() will run.
1604
1605 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the
1606 "permanent link" tab
1607 $sktemplate: SkinTemplate object
1608 $nav_urls: array of tabs
1609
1610 Alter the structured navigation links in SkinTemplates, there are three of these hooks called in different spots.
1611 'SkinTemplateNavigation': Called on content pages after the tabs have been added but before before variants have been added
1612 'SkinTemplateNavigation::SpecialPage': Called on special pages after the special tab is added but before variants have been added
1613 'SkinTemplateNavigation::Universal': Called on both content and special pages after variants have been added
1614 &$sktemplate: SkinTemplate object
1615 &$links: Structured navigation links
1616 This is used to alter the navigation for skins which use buildNavigationUrls such as Vector.
1617
1618 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage()
1619 starts page output
1620 &$sktemplate: SkinTemplate object
1621 &$tpl: Template engine object
1622
1623 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1624 $sktemplate: SkinTemplate object
1625 $res: set to true to prevent active tabs
1626
1627 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1628 You can either create your own array, or alter the parameters for
1629 the normal one.
1630 &$sktemplate: The SkinTemplate instance.
1631 $title: Title instance for the page.
1632 $message: Visible label of tab.
1633 $selected: Whether this is a selected tab.
1634 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1635 &$classes: Array of CSS classes to apply.
1636 &$query: Query string to add to link.
1637 &$text: Link text.
1638 &$result: Complete assoc. array if you want to return true.
1639
1640 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have
1641 been rendered (useful for adding more)
1642 $sk: The QuickTemplate based skin template running the hook.
1643
1644 'SoftwareInfo': Called by Special:Version for returning information about
1645 the software
1646 $software: The array of software in format 'name' => 'version'.
1647 See SpecialVersion::softwareInformation()
1648
1649 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1650 $id: User identifier
1651
1652 'SpecialListusersDefaultQuery': called right before the end of
1653 UsersPager::getDefaultQuery()
1654 $pager: The UsersPager instance
1655 $query: The query array to be returned
1656
1657 'SpecialListusersFormatRow': called right before the end of
1658 UsersPager::formatRow()
1659 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1660 $row: Database row object
1661
1662 'SpecialListusersHeader': called before closing the <fieldset> in
1663 UsersPager::getPageHeader()
1664 $pager: The UsersPager instance
1665 $out: The header HTML
1666
1667 'SpecialListusersHeaderForm': called before adding the submit button in
1668 UsersPager::getPageHeader()
1669 $pager: The UsersPager instance
1670 $out: The header HTML
1671
1672 'SpecialListusersQueryInfo': called right before the end of
1673 UsersPager::getQueryInfo()
1674 $pager: The UsersPager instance
1675 $query: The query array to be returned
1676
1677 'SpecialMovepageAfterMove': called after moving a page
1678 $movePage: MovePageForm object
1679 $oldTitle: old title (object)
1680 $newTitle: new title (object)
1681
1682 'SpecialNewpagesConditions': called when building sql query for Special:NewPages
1683 &$special: NewPagesPager object (subclass of ReverseChronologicalPager)
1684 $opts: FormOptions object containing special page options
1685 &$conds: array of WHERE conditionals for query
1686 &tables: array of tables to be queried
1687 &$fields: array of columns to select
1688 &$join_conds: join conditions for the tables
1689
1690 'SpecialNewPagesFilters': called after building form options at NewPages
1691 $special: the special page object
1692 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1693 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1694
1695 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this
1696 hook to remove a core special page
1697 $list: list (array) of core special pages
1698
1699 'SpecialPasswordResetOnSubmit': when executing a form submission on Special:PasswordReset
1700 $users: array of User objects
1701 $data: array of data submitted by the user
1702 &$error: string, error code (message name) used to describe to error (out paramater).
1703 The hook needs to return false when setting this, otherwise it will have no effect.
1704
1705 'SpecialRandomGetRandomTitle': called during the execution of Special:Random,
1706 use this to change some selection criteria or substitute a different title
1707 &$randstr: The random number from wfRandom()
1708 &$isRedir: Boolean, whether to select a redirect or non-redirect
1709 &$namespaces: An array of namespace indexes to get the title from
1710 &$extra: An array of extra SQL statements
1711 &$title: If the hook returns false, a Title object to use instead of the
1712 result from the normal query
1713
1714 'SpecialRecentChangesFilters': called after building form options at RecentChanges
1715 $special: the special page object
1716 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1717 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1718
1719 'SpecialRecentChangesPanel': called when building form options in
1720 SpecialRecentChanges
1721 &$extraOpts: array of added items, to which can be added
1722 $opts: FormOptions for this request
1723
1724 'SpecialRecentChangesQuery': called when building sql query for
1725 SpecialRecentChanges and SpecialRecentChangesLinked
1726 &$conds: array of WHERE conditionals for query
1727 &$tables: array of tables to be queried
1728 &$join_conds: join conditions for the tables
1729 $opts: FormOptions for this request
1730 &$query_options: array of options for the database request
1731 &$select: Array of columns to select
1732
1733 'SpecialSearchGo': called when user clicked the "Go"
1734 &$title: title object generated from the text entered by the user
1735 &$term: the search term entered by the user
1736
1737 'SpecialSearchNogomatch': called when user clicked the "Go" button but the
1738 target doesn't exist
1739 &$title: title object generated from the text entered by the user
1740
1741 'SpecialSearchProfiles': allows modification of search profiles
1742 &$profiles: profiles, which can be modified.
1743
1744 'SpecialSearchProfileForm': allows modification of search profile forms
1745 $search: special page object
1746 &$form: String: form html
1747 $profile: String: current search profile
1748 $term: String: search term
1749 $opts: Array: key => value of hidden options for inclusion in custom forms
1750
1751 'SpecialSearchSetupEngine': allows passing custom data to search engine
1752 $search: special page object
1753 $profile: String: current search profile
1754 $engine: the search engine
1755
1756 'SpecialSearchResults': called before search result display when there
1757 are matches
1758 $term: string of search term
1759 &$titleMatches: empty or SearchResultSet object
1760 &$textMatches: empty or SearchResultSet object
1761
1762 'SpecialSearchNoResults': called before search result display when there are
1763 no matches
1764 $term: string of search term
1765
1766 'SpecialStatsAddExtra': add extra statistic at the end of Special:Statistics
1767 &$extraStats: Array to save the new stats
1768 ( $extraStats['<name of statistic>'] => <value>; )
1769
1770 'SpecialUploadComplete': Called after successfully uploading a file from
1771 Special:Upload
1772 $form: The SpecialUpload object
1773
1774 'SpecialVersionExtensionTypes': called when generating the extensions credits,
1775 use this to change the tables headers
1776 $extTypes: associative array of extensions types
1777
1778 'SpecialWatchlistFilters': called after building form options at Watchlist
1779 $special: the special page object
1780 &$filters: associative array of filter definitions. The keys are the HTML name/URL parameters.
1781 Each key maps to an associative array with a 'msg' (message key) and a 'default' value.
1782
1783 'SpecialWatchlistQuery': called when building sql query for SpecialWatchlist
1784 &$conds: array of WHERE conditionals for query
1785 &$tables: array of tables to be queried
1786 &$join_conds: join conditions for the tables
1787 &$fields: array of query fields
1788
1789 'TitleArrayFromResult': called when creating an TitleArray object from a
1790 database result
1791 &$titleArray: set this to an object to override the default object returned
1792 $res: database result used to create the object
1793
1794 'TitleGetRestrictionTypes': Allows extensions to modify the types of protection
1795 that can be applied.
1796 $title: The title in question.
1797 &$types: The types of protection available.
1798
1799 'TitleIsCssOrJsPage': Called when determining if a page is a CSS or JS page
1800 $title: Title object that is being checked
1801 $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()
1802
1803 'TitleIsMovable': Called when determining if it is possible to move a page
1804 $title: Title object that is being checked
1805 $result: Boolean; whether MediaWiki currently thinks this page is movable. Hooks may change this value to override the return value of Title::isMovable()
1806
1807 'TitleIsWikitextPage': Called when determining if a page is a wikitext or should
1808 be handled by seperate handler (via ArticleViewCustom)
1809 $title: Title object that is being checked
1810 $result: Boolean; whether MediaWiki currently thinks this is a wikitext page. Hooks may change this value to override the return value of Title::isWikitextPage()
1811
1812 'TitleMoveComplete': after moving an article (title)
1813 $old: old title
1814 $nt: new title
1815 $user: user who did the move
1816 $pageid: database ID of the page that's been moved
1817 $redirid: database ID of the created redirect
1818
1819 'UndeleteForm::showHistory': called in UndeleteForm::showHistory, after a
1820 PageArchive object has been created but before any further processing is done.
1821 &$archive: PageArchive object
1822 $title: Title object of the page that we're viewing
1823
1824 'UndeleteForm::showRevision': called in UndeleteForm::showRevision, after a
1825 PageArchive object has been created but before any further processing is done.
1826 &$archive: PageArchive object
1827 $title: Title object of the page that we're viewing
1828
1829 'UndeleteForm::undelete': called un UndeleteForm::undelete, after checking that
1830 the site is not in read-only mode, that the Title object is not null and after
1831 a PageArchive object has been constructed but before performing any further
1832 processing.
1833 &$archive: PageArchive object
1834 $title: Title object of the page that we're about to undelete
1835
1836 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1837 $title: title object related to the revision
1838 $rev: revision (object) that will be viewed
1839
1840 'UnknownAction': An unknown "action" has occured (useful for defining
1841 your own actions)
1842 $action: action name
1843 $article: article "acted on"
1844
1845 'UnitTestsList': Called when building a list of files with PHPUnit tests
1846 &$files: list of files
1847
1848 'UnwatchArticle': before a watch is removed from an article
1849 $user: user watching
1850 $article: article object to be removed
1851
1852 'UnwatchArticle': after a watch is removed from an article
1853 $user: user that was watching
1854 $article: article object removed
1855
1856 'UnwatchArticleComplete': after a watch is removed from an article
1857 $user: user that watched
1858 $article: article object that was watched
1859
1860 'UploadForm:initial': before the upload form is generated
1861 $form: UploadForm object
1862 You might set the member-variables $uploadFormTextTop and
1863 $uploadFormTextAfterSummary to inject text (HTML) either before
1864 or after the editform.
1865
1866 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1867 $form: UploadForm object
1868 Lets you poke at member variables like $mUploadDescription before the
1869 file is saved.
1870 Do not use this hook to break upload processing. This will return the user to
1871 a blank form with no error message; use UploadVerification and
1872 UploadVerifyFile instead
1873
1874 'UploadCreateFromRequest': when UploadBase::createFromRequest has been called
1875 $type: (string) the requested upload type
1876 &$className: the class name of the Upload instance to be created
1877
1878 'UploadComplete': when Upload completes an upload
1879 &$upload: an UploadBase child instance
1880
1881 'UploadFormInitDescriptor': after the descriptor for the upload form as been
1882 assembled
1883 $descriptor: (array) the HTMLForm descriptor
1884
1885 'UploadFormSourceDescriptors': after the standard source inputs have been
1886 added to the descriptor
1887 $descriptor: (array) the HTMLForm descriptor
1888
1889 'UploadVerification': additional chances to reject an uploaded file. Consider
1890 using UploadVerifyFile instead.
1891 string $saveName: destination file name
1892 string $tempName: filesystem path to the temporary file for checks
1893 string &$error: output: message key for message to show if upload canceled
1894 by returning false. May also be an array, where the first element
1895 is the message key and the remaining elements are used as parameters to
1896 the message.
1897
1898 'UploadVerifyFile': extra file verification, based on mime type, etc. Preferred
1899 in most cases over UploadVerification.
1900 object $upload: an instance of UploadBase, with all info about the upload
1901 string $mime: the uploaded file's mime type, as detected by MediaWiki. Handlers
1902 will typically only apply for specific mime types.
1903 object &$error: output: true if the file is valid. Otherwise, an indexed array
1904 representing the problem with the file, where the first element
1905 is the message key and the remaining elements are used as parameters to
1906 the message.
1907
1908 'UploadComplete': Upon completion of a file upload
1909 $uploadBase: UploadBase (or subclass) object. File can be accessed by
1910 $uploadBase->getLocalFile().
1911
1912 'User::mailPasswordInternal': before creation and mailing of a user's new
1913 temporary password
1914 $user: the user who sent the message out
1915 $ip: IP of the user who sent the message out
1916 $u: the account whose new password will be set
1917
1918 'UserAddGroup': called when adding a group; return false to override
1919 stock group addition.
1920 $user: the user object that is to have a group added
1921 &$group: the group to add, can be modified
1922
1923 'UserArrayFromResult': called when creating an UserArray object from a
1924 database result
1925 &$userArray: set this to an object to override the default object returned
1926 $res: database result used to create the object
1927
1928 'userCan': To interrupt/advise the "user can do X to Y article" check.
1929 If you want to display an error message, try getUserPermissionsErrors.
1930 $title: Title object being checked against
1931 $user : Current user object
1932 $action: Action being checked
1933 $result: Pointer to result returned if hook returns false. If null is returned,
1934 userCan checks are continued by internal code.
1935
1936 'UserCanSendEmail': To override User::canSendEmail() permission check
1937 $user: User (object) whose permission is being checked
1938 &$canSend: bool set on input, can override on output
1939
1940 'UserClearNewTalkNotification': called when clearing the
1941 "You have new messages!" message, return false to not delete it
1942 $user: User (object) that'll clear the message
1943
1944 'UserComparePasswords': called when checking passwords, return false to
1945 override the default password checks
1946 &$hash: String of the password hash (from the database)
1947 &$password: String of the plaintext password the user entered
1948 &$userId: Integer of the user's ID or Boolean false if the user ID was not
1949 supplied
1950 &$result: If the hook returns false, this Boolean value will be checked to
1951 determine if the password was valid
1952
1953 'UserCreateForm': change to manipulate the login form
1954 $template: SimpleTemplate instance for the form
1955
1956 'UserCryptPassword': called when hashing a password, return false to implement
1957 your own hashing method
1958 &$password: String of the plaintext password to encrypt
1959 &$salt: String of the password salt or Boolean false if no salt is provided
1960 &$wgPasswordSalt: Boolean of whether the salt is used in the default
1961 hashing method
1962 &$hash: If the hook returns false, this String will be used as the hash
1963
1964 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1965 $user: User to get groups for
1966 &$groups: Current effective groups
1967
1968 'UserGetAllRights': after calculating a list of all available rights
1969 &$rights: Array of rights, which may be added to.
1970
1971 'UserGetEmail': called when getting an user email address
1972 $user: User object
1973 &$email: email, change this to override local email
1974
1975 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of
1976 email authentification
1977 $user: User object
1978 &$timestamp: timestamp, change this to override local email authentification
1979 timestamp
1980
1981 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1982 &$groups: List of implicit (automatically-assigned) groups
1983
1984 'UserGetLanguageObject': Called when getting user's interface language object
1985 $user: User object
1986 &$code: Langauge code that will be used to create the object
1987
1988 'UserGetReservedNames': allows to modify $wgReservedUsernames at run time
1989 &$reservedUsernames: $wgReservedUsernames
1990
1991 'UserGetRights': Called in User::getRights()
1992 $user: User to get rights for
1993 &$rights: Current rights
1994
1995 'UserIsBlockedFrom': Check if a user is blocked from a specific page (for specific block
1996 exemptions).
1997 $user: User in question
1998 $title: Title of the page in question
1999 &$blocked: Out-param, whether or not the user is blocked from that page.
2000 &$allowUsertalk: If the user is blocked, whether or not the block allows users to edit their
2001 own user talk pages.
2002
2003 'UserIsBlockedGlobally': Check if user is blocked on all wikis.
2004 &$user: User object
2005 $ip: User's IP address
2006 &$blocked: Whether the user is blocked, to be modified by the hook
2007
2008 'UserLoadAfterLoadFromSession': called to authenticate users on
2009 external/environmental means; occurs after session is loaded
2010 $user: user object being loaded
2011
2012 'UserLoadDefaults': called when loading a default user
2013 $user: user object
2014 $name: user name
2015
2016 'UserLoadFromDatabase': called when loading a user from the database
2017 $user: user object
2018 &$s: database query object
2019
2020 'UserLoadFromSession': called to authenticate users on external/environmental
2021 means; occurs before session is loaded
2022 $user: user object being loaded
2023 &$result: set this to a boolean value to abort the normal authentification
2024 process
2025
2026 'UserLoadOptions': when user options/preferences are being loaded from
2027 the database.
2028 $user: User object
2029 &$options: Options, can be modified.
2030
2031 'UserLoginComplete': after a user has logged in
2032 $user: the user object that was created on login
2033 $inject_html: Any HTML to inject after the "logged in" message.
2034
2035 'UserLoginForm': change to manipulate the login form
2036 $template: SimpleTemplate instance for the form
2037
2038 'UserLogout': before a user logs out
2039 $user: the user object that is about to be logged out
2040
2041 'UserLogoutComplete': after a user has logged out
2042 $user: the user object _after_ logout (won't have name, ID, etc.)
2043 $inject_html: Any HTML to inject after the "logged out" message.
2044 $oldName: name of the user before logout (string)
2045
2046 'UserRemoveGroup': called when removing a group; return false to override
2047 stock group removal.
2048 $user: the user object that is to have a group removed
2049 &$group: the group to be removed, can be modified
2050
2051 'UserRights': After a user's group memberships are changed
2052 $user : User object that was changed
2053 $add : Array of strings corresponding to groups added
2054 $remove: Array of strings corresponding to groups removed
2055
2056 'UserRetrieveNewTalks': called when retrieving "You have new messages!"
2057 message(s)
2058 $user: user retrieving new talks messages
2059 $talks: array of new talks page(s)
2060
2061 'UserSaveSettings': called when saving user settings
2062 $user: User object
2063
2064 'UserSaveOptions': Called just before saving user preferences/options.
2065 $user: User object
2066 &$options: Options, modifiable
2067
2068 'UserSetCookies': called when setting user cookies
2069 $user: User object
2070 &$session: session array, will be added to $_SESSION
2071 &$cookies: cookies array mapping cookie name to its value
2072
2073 'UserSetEmail': called when changing user email address
2074 $user: User object
2075 &$email: new email, change this to override new email address
2076
2077 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp
2078 of email authentification
2079 $user: User object
2080 &$timestamp: new timestamp, change this to override local email
2081 authentification timestamp
2082
2083 'WantedPages::getQueryInfo': called in WantedPagesPage::getQueryInfo(), can be
2084 used to alter the SQL query which gets the list of wanted pages
2085 &$wantedPages: WantedPagesPage object
2086 &$query: query array, see QueryPage::getQueryInfo() for format documentation
2087
2088 'WatchArticle': before a watch is added to an article
2089 $user: user that will watch
2090 $article: article object to be watched
2091
2092 'WatchArticleComplete': after a watch is added to an article
2093 $user: user that watched
2094 $article: article object watched
2095
2096 'WatchlistEditorBuildRemoveLine': when building remove lines in
2097 Special:Watchlist/edit
2098 &$tools: array of extra links
2099 $title: Title object
2100 $redirect: whether the page is a redirect
2101 $skin: Skin object
2102
2103 'WebRequestGetPathInfoRequestURI': while extracting path info from REQUEST_URI.
2104 Allows an extension to extend the extraction of titles from paths.
2105 Implementing hooks should follow the pattern used in core:
2106 * Use the `$matches = WebRequest::extractTitle` pattern
2107 * Ensure that you test `if ( !$matches ) {` before you try extracting a title
2108 from the path so that you don't override an already found match.
2109 $path: The request path to extract a title from.
2110 &$matches: The array to apply matches to.
2111
2112 'WikiExporter::dumpStableQuery': Get the SELECT query for "stable" revisions
2113 dumps
2114 One, and only one hook should set this, and return false.
2115 &$tables: Database tables to use in the SELECT query
2116 &$opts: Options to use for the query
2117 &$join: Join conditions
2118
2119 'wgQueryPages': called when initialising $wgQueryPages, use this to add new
2120 query pages to be updated with maintenance/updateSpecialPages.php
2121 $query: $wgQueryPages itself
2122
2123 'XmlDumpWriterOpenPage': Called at the end of XmlDumpWriter::openPage, to allow extra
2124 metadata to be added.
2125 $obj: The XmlDumpWriter object.
2126 &$out: The output string.
2127 $row: The database row for the page.
2128 $title: The title of the page.
2129
2130 'XmlDumpWriterWriteRevision': Called at the end of a revision in an XML dump, to add extra
2131 metadata.
2132 $obj: The XmlDumpWriter object.
2133 &$out: The text being output.
2134 $row: The database row for the revision.
2135 $text: The revision text.
2136
2137 'XMPGetInfo': Called when obtaining the list of XMP tags to extract. Can be used to add
2138 additional tags to extract.
2139 &$items: Array containing information on which items to extract. See XMPInfo for details on the format.
2140
2141 'XMPGetResults': Called just before returning the results array of parsing xmp data. Can be
2142 used to post-process the results.
2143 &$data: Array of metadata sections (such as $data['xmp-general']) each section is an array of
2144 metadata tags returned (each tag is either a value, or an array of values).
2145
2146 More hooks might be available but undocumented, you can execute
2147 ./maintenance/findhooks.php to find hidden one.