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