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