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