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