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