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