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