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