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