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