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