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