Added parameter to BeforePageDisplay hook so that extension can use it to modify...
[lhc/web/wiklou.git] / docs / hooks.txt
1 hooks.txt
2
3 This document describes how event hooks work in MediaWiki; how to add
4 hooks for 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
10 in. A wiki page is saved. A wiki page is deleted. Often there are
11 two events associated with a single action: one before the code
12 is run to make the event happen, and one after. Each event has a
13 name, preferably in CamelCase. For example, 'UserLogin',
14 'ArticleSave', 'ArticleSaveComplete', 'ArticleDelete'.
15
16 hook
17 A clump of code and data that should be run when an event
18 happens. This can be either a function and a chunk of data, or an
19 object and a method.
20
21 hook function
22 The function part of a hook.
23
24 ==Rationale==
25
26 Hooks allow us to decouple optionally-run code from code that is run
27 for everyone. It allows MediaWiki hackers, third-party developers and
28 local administrators to define code that will be run at certain points
29 in the mainline code, and to modify the data run by that mainline
30 code. Hooks can keep mainline code simple, and make it easier to
31 write extensions. Hooks are a principled alternative to local patches.
32
33 Consider, for example, two options in MediaWiki. One reverses the
34 order of a title before displaying the article; the other converts the
35 title to all uppercase letters. Currently, in MediaWiki code, we
36 would handle this as follows (note: not real code, here):
37
38 function showAnArticle($article) {
39 global $wgReverseTitle, $wgCapitalizeTitle;
40
41 if ($wgReverseTitle) {
42 wfReverseTitle($article);
43 }
44
45 if ($wgCapitalizeTitle) {
46 wfCapitalizeTitle($article);
47 }
48
49 # code to actually show the article goes here
50 }
51
52 An extension writer, or a local admin, will often add custom code to
53 the function -- with or without a global variable. For example,
54 someone wanting email notification when an article is shown may add:
55
56 function showAnArticle($article) {
57 global $wgReverseTitle, $wgCapitalizeTitle;
58
59 if ($wgReverseTitle) {
60 wfReverseTitle($article);
61 }
62
63 if ($wgCapitalizeTitle) {
64 wfCapitalizeTitle($article);
65 }
66
67 # code to actually show the article goes here
68
69 if ($wgNotifyArticle) {
70 wfNotifyArticleShow($article));
71 }
72 }
73
74 Using a hook-running strategy, we can avoid having all this
75 option-specific stuff in our mainline code. Using hooks, the function
76 becomes:
77
78 function showAnArticle($article) {
79
80 if (wfRunHooks('ArticleShow', array(&$article))) {
81
82 # code to actually show the article goes here
83
84 wfRunHooks('ArticleShowComplete', array(&$article));
85 }
86 }
87
88 We've cleaned up the code here by removing clumps of weird,
89 infrequently used code and moving them off somewhere else. It's much
90 easier for someone working with this code to see what's _really_ going
91 on, and make changes or fix bugs.
92
93 In addition, we can take all the code that deals with the little-used
94 title-reversing options (say) and put it in one place. Instead of
95 having little title-reversing if-blocks spread all over the codebase
96 in showAnArticle, deleteAnArticle, exportArticle, etc., we can
97 concentrate it all in an extension file:
98
99 function reverseArticleTitle($article) {
100 # ...
101 }
102
103 function reverseForExport($article) {
104 # ...
105 }
106
107 The setup function for the extension just has to add its hook
108 functions to the appropriate events:
109
110 setupTitleReversingExtension() {
111 global $wgHooks;
112
113 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
114 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
115 $wgHooks['ArticleExport'][] = 'reverseForExport';
116 }
117
118 Having all this code related to the title-reversion option in one
119 place means that it's easier to read and understand; you don't have to
120 do a grep-find to see where the $wgReverseTitle variable is used, say.
121
122 If the code is well enough isolated, it can even be excluded when not
123 used -- making for some slight savings in memory and load-up
124 performance at runtime. Admins who want to have all the reversed
125 titles can add:
126
127 require_once('extensions/ReverseTitle.php');
128
129 ...to their LocalSettings.php file; those of us who don't want or need
130 it can just leave it out.
131
132 The extensions don't even have to be shipped with MediaWiki; they
133 could be provided by a third-party developer or written by the admin
134 him/herself.
135
136 ==Writing hooks==
137
138 A hook is a chunk of code run at some particular event. It consists of:
139
140 * a function with some optional accompanying data, or
141 * an object with a method and some optional accompanying data.
142
143 Hooks are registered by adding them to the global $wgHooks array for a
144 given event. All the following are valid ways to define hooks:
145
146 $wgHooks['EventName'][] = 'someFunction'; # function, no data
147 $wgHooks['EventName'][] = array('someFunction', $someData);
148 $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
149
150 $wgHooks['EventName'][] = $object; # object only
151 $wgHooks['EventName'][] = array($object, 'someMethod');
152 $wgHooks['EventName'][] = array($object, 'someMethod', $someData);
153 $wgHooks['EventName'][] = array($object); # weird but OK
154
155 When an event occurs, the function (or object method) will be called
156 with the optional data provided as well as event-specific parameters.
157 The above examples would result in the following code being executed
158 when 'EventName' happened:
159
160 # function, no data
161 someFunction($param1, $param2)
162 # function with data
163 someFunction($someData, $param1, $param2)
164
165 # object only
166 $object->onEventName($param1, $param2)
167 # object with method
168 $object->someMethod($param1, $param2)
169 # object with method and data
170 $object->someMethod($someData, $param1, $param2)
171
172 Note that when an object is the hook, and there's no specified method,
173 the default method called is 'onEventName'. For different events this
174 would be different: 'onArticleSave', 'onUserLogin', etc.
175
176 The extra data is useful if we want to use the same function or object
177 for different purposes. For example:
178
179 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
180 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
181
182 This code would result in ircNotify being run twice when an article is
183 saved: once for 'TimStarling', and once for 'brion'.
184
185 Hooks can return three possible values:
186
187 * true: the hook has operated successfully
188 * "some string": an error occurred; processing should
189 stop and the error should be shown to the user
190 * false: the hook has successfully done the work
191 necessary and the calling function should skip
192
193 The last result would be for cases where the hook function replaces
194 the main functionality. For example, if you wanted to authenticate
195 users to a custom system (LDAP, another PHP program, whatever), you
196 could do:
197
198 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
199
200 function ldapLogin($username, $password) {
201 # log user into LDAP
202 return false;
203 }
204
205 Returning false makes less sense for events where the action is
206 complete, and will normally be ignored.
207
208 ==Using hooks==
209
210 A calling function or method uses the wfRunHooks() function to run
211 the hooks related to a particular event, like so:
212
213 class Article {
214 # ...
215 function protect() {
216 global $wgUser;
217 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
218 # protect the article
219 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
220 }
221 }
222 }
223
224 wfRunHooks() returns true if the calling function should continue
225 processing (the hooks ran OK, or there are no hooks to run), or false
226 if it shouldn't (an error occurred, or one of the hooks handled the
227 action already). Checking the return value matters more for "before"
228 hooks than for "complete" hooks.
229
230 Note that hook parameters are passed in an array; this is a necessary
231 inconvenience to make it possible to pass reference values (that can
232 be changed) into the hook code. Also note that earlier versions of
233 wfRunHooks took a variable number of arguments; the array() calling
234 protocol came about after MediaWiki 1.4rc1.
235
236 ==Events and parameters==
237
238 This is a list of known events and parameters; please add to it if
239 you're going to add events to the MediaWiki code.
240
241 'AbortLogin': Return false to cancel account login.
242 $user: the User object being authenticated against
243 $password: the password being submitted, not yet checked for validity
244 &$retval: a LoginForm class constant to return from authenticateUserData();
245 default is LoginForm::ABORTED. Note that the client may be using
246 a machine API rather than the HTML user interface.
247
248 'AbortMove': allows to abort moving an article (title)
249 $old: old title
250 $nt: new title
251 $user: user who is doing the move
252 $err: error message
253
254 'AbortNewAccount': Return false to cancel account creation.
255 $user: the User object about to be created (read-only, incomplete)
256 $message: out parameter: error message to display on abort
257
258 'AddNewAccount': after a user account is created
259 $user: the User object that was created. (Parameter added in 1.7)
260 $byEmail: true when account was created "by email" (added in 1.12)
261
262 'AjaxAddScript': Called in output page just before the initialisation
263 of the javascript ajax engine. The hook is only called when ajax
264 is enabled ( $wgUseAjax = true; ).
265
266 'AlternateEdit': before checking if an user can edit a page and
267 before showing the edit form ( EditPage::edit() ). This is triggered
268 on &action=edit.
269 $EditPage : the EditPage object
270
271 'APIEditBeforeSave': before saving a page with api.php?action=edit,
272 after processing request parameters. Return false to let the request
273 fail, returning an error message or an <edit result="Failure"> tag
274 if $resultArr was filled.
275 $EditPage : the EditPage object
276 $text : the new text of the article (has yet to be saved)
277 $resultArr : data in this array will be added to the API result
278
279 'ArticleAfterFetchContent': after fetching content of an article from the database
280 $article: the article (object) being loaded from the database
281 $content: the content (string) of the article
282
283 'ArticleDelete': before an article is deleted
284 $article: the article (object) being deleted
285 $user: the user (object) deleting the article
286 $reason: the reason (string) the article is being deleted
287
288 'ArticleDeleteComplete': after an article is deleted
289 $article: the article that was deleted
290 $user: the user that deleted the article
291 $reason: the reason the article was deleted
292
293 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
294 $article: article (object) of the user talk page
295
296 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
297 $article: article (object) being modified
298
299 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
300 $title: title (object) used to create the article object
301 $article: article (object) that will be returned
302
303 'ArticleInsertComplete': After an article is created
304 $article: Article created
305 $user: User creating the article
306 $text: New content
307 $summary: Edit summary/comment
308 $isMinor: Whether or not the edit was marked as minor
309 $isWatch: (No longer used)
310 $section: (No longer used)
311 $flags: Flags passed to Article::doEdit()
312 $revision: New Revision of the article
313
314 'ArticleMergeComplete': after merging to article using Special:Mergehistory
315 $targetTitle: target title (object)
316 $destTitle: destination title (object)
317
318 'ArticlePageDataAfter': after loading data of an article from the database
319 $article: article (object) whose data were loaded
320 $row: row (object) returned from the database server
321
322 'ArticlePageDataBefore': before loading data of an article from the database
323 $article: article (object) that data will be loaded
324 $fields: fileds (array) to load from the database
325
326 'ArticleProtect': before an article is protected
327 $article: the article being protected
328 $user: the user doing the protection
329 $protect: boolean whether this is a protect or an unprotect
330 $reason: Reason for protect
331 $moveonly: boolean whether this is for move only or not
332
333 'ArticleProtectComplete': after an article is protected
334 $article: the article that was protected
335 $user: the user who did the protection
336 $protect: boolean whether it was a protect or an unprotect
337 $reason: Reason for protect
338 $moveonly: boolean whether it was for move only or not
339
340 'ArticlePurge': before executing "&action=purge"
341 $article: article (object) to purge
342
343 'ArticleRevisionVisiblitySet': called when changing visibility of one or more
344 revision of an article
345 &$title: title object of the article
346
347 'ArticleRevisionUndeleted': after an article revision is restored
348 $title: the article title
349 $revision: the revision
350 $oldPageID: the page ID of the revision when archived (may be null)
351
352 'ArticleRollbackComplete': after an article rollback is completed
353 $article: the article that was edited
354 $user: the user who did the rollback
355 $revision: the revision the page was reverted back to
356
357 'ArticleSave': before an article is saved
358 $article: the article (object) being saved
359 $user: the user (object) saving the article
360 $text: the new article text
361 $summary: the article summary (comment)
362 $isminor: minor flag
363 $iswatch: watch flag
364 $section: section #
365
366 'ArticleSaveComplete': After an article has been updated
367 $article: Article modified
368 $user: User performing the modification
369 $text: New content
370 $summary: Edit summary/comment
371 $isMinor: Whether or not the edit was marked as minor
372 $isWatch: (No longer used)
373 $section: (No longer used)
374 $flags: Flags passed to Article::doEdit()
375 $revision: New Revision of the article
376
377 'ArticleSaveComplete': after an article is saved
378 $article: the article (object) saved
379 $user: the user (object) who saved the article
380 $text: the new article text
381 $summary: the article summary (comment)
382 $isminor: minor flag
383 $iswatch: watch flag
384 $section: section #
385
386 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
387
388 'ArticleUndelete': When one or more revisions of an article are restored
389 $title: Title corresponding to the article restored
390 $create: Whether or not the restoration caused the page to be created
391 (i.e. it didn't exist before)
392
393 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
394 &$article: the article
395 &$sectionanchor: The section anchor link (e.g. "#overview" )
396 &$extraq: Extra query parameters which can be added via hooked functions
397
398 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
399 &$article: the article
400 &$pcache: whether to try the parser cache or not
401 &$outputDone: whether the output for this page finished or not
402
403 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
404 $article: target article (object)
405
406 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
407 Gives a chance for an extension to set it programattically to a variable class.
408 &$auth: the $wgAuth object, probably a stub
409
410 'AutoAuthenticate': called to authenticate users on external/environmental means
411 $user: writes user object to this parameter
412
413 'AutopromoteCondition': check autopromote condition for user.
414 $type: condition type
415 $args: arguments
416 $user: user
417 $result: result of checking autopromote condition
418
419 'BadImage': When checking against the bad image list
420 $name: Image name being checked
421 &$bad: Whether or not the image is "bad"
422
423 Change $bad and return false to override. If an image is "bad", it is not
424 rendered inline in wiki pages or galleries in category pages.
425
426 'BeforeGalleryFindFile': before an image is fetched for a gallery
427 &$gallery,: the gallery object
428 &$nt: the image title
429 &$time: image timestamp
430
431 'BeforePageDisplay': Prior to outputting a page
432 &$out: OutputPage object
433 &$skin: Skin object
434
435 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
436 &$parser: Parser object
437 &$title: title of the template
438 &$skip: skip this template and link it?
439 &$id: the id of the revision being parsed
440
441 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
442 &$parser: Parser object
443 &$nt: the image title
444 &$skip: skip this image and link it?
445 &$time: the image timestamp
446
447 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
448 &$parser: Parser object
449 &$ig: ImageGallery object
450
451 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
452 $nondefaults: Assoc array with the following keys:
453 days, hideOwn, hideBots, hideMinor, namespace
454 $wgUser: wgUser.
455 &$hookSql: a string which will be inserted without sanitation into the SQL query
456 used to get the watchlist, at the end of the WHERE part.
457
458 'BlockIp': before an IP address or user is blocked
459 $block: the Block object about to be saved
460 $user: the user _doing_ the block (not the one being blocked)
461
462 'BlockIpComplete': after an IP address or user is blocked
463 $block: the Block object that was saved
464 $user: the user who did the block (not the one being blocked)
465
466 'BookInformation': Before information output on Special:Booksources
467 $isbn: ISBN to show information for
468 $output: OutputPage object in use
469
470 'BrokenLink': Before the HTML is created for a broken (i.e. red) link
471 &$this: Linker instance
472 $nt: the page title
473 $query: the URL query string passed in
474 &$u: the URL of this link
475 &$style: the inline CSS style
476 &$prefix: a prefix prepended to the linked text
477 &$text: the text placed by the user in the wiki-link
478 &$inside: any additional alphanumeric characters placed after the wiki-link,
479 that are made part of the link text
480 &$trail: text placed immediately after the HTML link
481
482 'CategoryPageView': before viewing a categorypage in CategoryPage::view
483 $catpage: CategoryPage instance
484
485 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
486 &$this: ChangesList instance.
487 &$articlelink: HTML of link to article (already filled-in).
488 &$s: HTML of row that is being constructed.
489 &$rc: RecentChange instance.
490 $unpatrolled: Whether or not we are showing unpatrolled changes.
491 $watched: Whether or not the change is watched by the user.
492
493 'ContributionsToolLinks': Change tool links above Special:Contributions
494 $id: User identifier
495 $title: User page title
496 &$tools: Array of tool links
497
498 'CustomEditor': When invoking the page editor
499 $article: Article being edited
500 $user: User performing the edit
501
502 Return true to allow the normal editor to be used, or false
503 if implementing a custom editor, e.g. for a special namespace,
504 etc.
505
506 'DiffViewHeader': called before diff display
507 $diff: DifferenceEngine object that's calling
508 $oldRev: Revision object of the "old" revision (may be null/invalid)
509 $newRev: Revision object of the "new" revision
510
511 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
512 $article: article (object) being viewed
513 $oldid: oldid (int) being viewed
514
515 'EditFilter': Perform checks on an edit
516 $editor: Edit form (see includes/EditPage.php)
517 $text: Contents of the edit box
518 $section: Section being edited
519 &$error: Error message to return
520
521 'EditFilterMerged': Post-section-merge edit filter
522 $editor: EditPage instance (object)
523 $text: content of the edit box
524 $error: error message to return
525
526 'EditFormPreloadText': Allows population of the edit form when creating new pages
527 &$text: Text to preload with
528 &$title: Title object representing the page being created
529
530 'EditPage::attemptSave': called before an article is
531 saved, that is before insertNewArticle() is called
532 &$editpage_Obj: the current EditPage object
533
534 'EditPage::showEditForm:fields': allows injection of form field into edit form
535 &$editor: the EditPage instance for reference
536 &$out: an OutputPage instance to write to
537 return value is ignored (should always return true)
538
539 'EditPage::showEditForm:initial': before showing the edit form
540 $editor: EditPage instance (object)
541
542 Return false to halt editing; you'll need to handle error messages, etc. yourself.
543 Alternatively, modifying $error and returning true will cause the contents of $error
544 to be echoed at the top of the edit form as wikitext. Return true without altering
545 $error to allow the edit to proceed.
546
547 'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form
548 &$editpage: The current EditPage object
549 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
550
551 'EditSectionLink': Override the return value of Linker::editSectionLink()
552 $skin: Skin rendering the UI
553 $title: Title being linked to
554 $section: Section to link to
555 $link: Default link
556 $result: Result (alter this to override the generated links)
557
558 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
559 $skin: Skin rendering the UI
560 $title: Title being linked to
561 $section: Section to link to
562 $hint: Anchor title/tooltip attributes
563 $link: Default link
564 $result: Result (alter this to override the generated links)
565
566 'EmailConfirmed': When checking that the user's email address is "confirmed"
567 $user: User being checked
568 $confirmed: Whether or not the email address is confirmed
569 This runs before the other checks, such as anonymity and the real check; return
570 true to allow those checks to occur, and false if checking is done.
571
572 'EmailUser': before sending email from one user to another
573 $to: address of receiving user
574 $from: address of sending user
575 $subject: subject of the mail
576 $text: text of the mail
577
578 'EmailUserComplete': after sending email from one user to another
579 $to: address of receiving user
580 $from: address of sending user
581 $subject: subject of the mail
582 $text: text of the mail
583
584 'FetchChangesList': When fetching the ChangesList derivative for a particular user
585 &$user: User the list is being fetched for
586 &$skin: Skin object to be used with the list
587 &$list: List object (defaults to NULL, change it to an object instance and return
588 false override the list derivative used)
589
590 'FileDeleteComplete': When a file is deleted
591 $file: reference to the deleted file
592 $oldimage: in case of the deletion of an old image, the name of the old file
593 $article: in case all revisions of the file are deleted a reference to the article
594 associated with the file.
595 $user: user who performed the deletion
596 $reason: reason
597
598 'FileUpload': When a file upload occurs
599 $file : Image object representing the file that was uploaded
600
601 'FileUndeleteComplete': When a file is undeleted
602 $title: title object to the file
603 $fileVersions: array of undeleted versions. Empty if all versions were restored
604 $user: user who performed the undeletion
605 $reason: reason
606
607 'GetBlockedStatus': after loading blocking status of an user from the database
608 $user: user (object) being checked
609
610 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
611 $title: Title object of page
612 $url: string value as output (out parameter, can modify)
613 $query: query options passed to Title::getFullURL()
614
615 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
616 $title: Title object of page
617 $url: string value as output (out parameter, can modify)
618 $query: query options passed to Title::getInternalURL()
619
620 'GetLinkColours': modify the CSS class of an array of page links
621 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
622 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
623
624 'GetLocalURL': modify local URLs as output into page links
625 $title: Title object of page
626 $url: string value as output (out parameter, can modify)
627 $query: query options passed to Title::getLocalURL()
628
629 'getUserPermissionsErrors': Add a permissions error when permissions errors are
630 checked for. Use instead of userCan for most cases. Return false if the
631 user can't do it, and populate $result with the reason in the form of
632 array( messagename, param1, param2, ... ). For consistency, error messages
633 should be plain text with no special coloring, bolding, etc. to show that
634 they're errors; presenting them properly to the user as errors is done by
635 the caller.
636 $title: Title object being checked against
637 $user : Current user object
638 $action: Action being checked
639 $result: User permissions error to add. If none, return true.
640
641 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
642 if expensive checks are enabled.
643
644 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
645 the image on an image page
646 $imagePage: ImagePage object ($this)
647 $output: $wgOut
648
649 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
650 image insertion. You can skip the default logic entirely by returning
651 false, or just modify a few things using call-by-reference.
652 &$this: Skin object
653 &$title: Title object of the image
654 &$file: File object, or false if it doesn't exist
655 &$frameParams: Various parameters with special meanings; see documentation in
656 includes/Linker.php for Linker::makeImageLink2
657 &$handlerParams: Various parameters with special meanings; see documentation in
658 includes/Linker.php for Linker::makeImageLink2
659 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
660 &$res: Final HTML output, used if you return false
661
662 'InitPreferencesForm': called at the end of PreferencesForm's constructor
663 $form: the PreferencesForm
664 $request: the web request to initialized from
665
666 'InternalParseBeforeLinks': during Parser's internalParse method before links but
667 after noinclude/includeonly/onlyinclude and other processing.
668 &$this: Parser object
669 &$text: string containing partially parsed text
670 &$this->mStripState: Parser's internal StripState object
671
672 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
673 $article: article (object) being checked
674
675 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
676 $ip: IP being check
677 $result: Change this value to override the result of wfIsTrustedProxy()
678
679 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
680 tance to return false if the domain name doesn't match your organization
681 $addr: The e-mail address entered by the user
682 &$result: Set this and return false to override the internal checks
683
684 'isValidPassword': Override the result of User::isValidPassword()
685 $password: The password entered by the user
686 &$result: Set this and return false to override the internal checks
687 $user: User the password is being validated for
688
689 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
690 $magicExtensions: associative array of magic words synonyms
691 $lang: laguage code (string)
692
693 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
694 $specialPageAliases: associative array of magic words synonyms
695 $lang: laguage code (string)
696
697 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
698 &$linksUpdate: the LinkUpdate object
699
700 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
701 &$linksUpdate: the LinkUpdate object
702
703 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
704 &$linksUpdate: the LinkUpdate object
705
706 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
707
708 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
709
710 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
711 No return data is accepted; this hook is for auditing only.
712 $user: the User object being authenticated against
713 $password: the password being submitted and found wanting
714 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
715
716 'LogLine': Processes a single log entry on Special:Log
717 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
718 database field.
719 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
720 to logging.log_action database field.
721 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
722 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
723 appears to contain anything.
724 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
725 &$revert: string that is displayed in the UI, similar to $comment.
726 $time: timestamp of the log entry (added in 1.12)
727
728 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
729 &$type: array of strings
730
731 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
732 &$typeText: array of strings
733
734 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
735 &$headerText: array of strings
736
737 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
738 &$actionText: array of strings
739
740 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
741 $magicWords: array of strings
742
743 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
744 $variableIDs: array of strings
745
746 'MarkPatrolled': before an edit is marked patrolled
747 $rcid: ID of the revision to be marked patrolled
748 $user: the user (object) marking the revision as patrolled
749 $wcOnlySysopsCanPatrol: config setting indicating whether the user
750 needs to be a sysop in order to mark an edit patrolled
751
752 'MarkPatrolledComplete': after an edit is marked patrolled
753 $rcid: ID of the revision marked as patrolled
754 $user: user (object) who marked the edit patrolled
755 $wcOnlySysopsCanPatrol: config setting indicating whether the user
756 must be a sysop to patrol the edit
757
758 'MathAfterTexvc': after texvc is executed when rendering mathematics
759 $mathRenderer: instance of MathRenderer
760 $errmsg: error message, in HTML (string). Nonempty indicates failure
761 of rendering the formula
762
763 'MediaWikiPerformAction': Override MediaWiki::performAction().
764 Use this to do something completely different, after the basic
765 globals have been set up, but before ordinary actions take place.
766 $output: $wgOut
767 $article: $wgArticle
768 $title: $wgTitle
769 $user: $wgUser
770 $request: $wgRequest
771
772 'MessagesPreLoad': When loading a message from the database
773 $title: title of the message (string)
774 $message: value (string), change it to the message you want to define
775
776 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
777 $tools: array of tools
778
779 'OutputPageBeforeHTML': a page has been processed by the parser and
780 the resulting HTML is about to be displayed.
781 $parserOutput: the parserOutput (object) that corresponds to the page
782 $text: the text that will be displayed, in HTML (string)
783
784 'OutputPageParserOutput': after adding a parserOutput to $wgOut
785 $out: OutputPage instance (object)
786 $parserOutput: parserOutput instance being added in $out
787
788 'PageHistoryBeforeList': When a history page list is about to be constructed.
789 $article: the article that the history is loading for
790
791 'PageHistoryLineEnding' : right before the end <li> is added to a history line
792 $row: the revision row for this line
793 $s: the string representing this parsed line
794
795 'PageRenderingHash': alter the parser cache option hash key
796 A parser extension which depends on user options should install
797 this hook and append its values to the key.
798 $hash: reference to a hash key string which can be modified
799
800 'ParserAfterStrip': Same as ParserBeforeStrip
801
802 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
803 $parser: Parser object being used
804 $text: text that'll be returned
805
806 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
807 $parser: Parser object
808 $text: text to parse
809 $stripState: StripState instance being used
810
811 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
812 $parser: parser object
813 $text: text being parsed
814 $stripState: stripState used (object)
815
816 'ParserBeforeTidy': called before tidy and custom tags replacements
817 $parser: Parser object being used
818 $text: actual text
819
820 'ParserClearState': called at the end of Parser::clearState()
821 $parser: Parser object being cleared
822
823 'ParserFirstCallInit': called when the parser initialises for the first time
824 &$parser: Parser object being cleared
825
826 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
827 $parser: Parser object
828 $varCache: array to store the value in case of multiples calls of the same magic word
829 $index: index (string) of the magic
830 $ret: value of the magic word (the hook should set it)
831
832 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
833 $parser: Parser object
834 $time: actual time (timestamp)
835
836 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
837 $parser: Parser object
838 $varCache: varaiable cache (array)
839
840 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
841 $parser: Parser object
842 $limitReport: text that will be included (without comment tags)
843
844 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
845 $title: title object representing the file
846 $file: file object that will be used to create the image
847 &$params: 2-D array of parameters
848
849 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
850 $parser: Parser object created
851
852 'ParserTestTables': alter the list of tables to duplicate when parser tests
853 are run. Use when page save hooks require the presence of custom tables
854 to ensure that tests continue to run properly.
855 &$tables: array of table names
856
857 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
858 my talk page, my contributions" etc).
859
860 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
861 &$title: Title object representing the current page
862
863 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
864 &$user : User performing the action
865 $action : Action being performed
866 &$result : Whether or not the action should be prevented
867 Change $result and return false to give a definitive answer, otherwise
868 the built-in rate limiting checks are used, if enabled.
869
870 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
871 $form : PreferencesForm object
872 &$html : HTML to append to
873
874 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
875 AJAX search suggestions. Put results into &$results outparam and return false.
876 $ns : int namespace key to search in
877 $search : search term (not guaranteed to be conveniently normalized)
878 $limit : maximum number of results to return
879 &$results : out param: array of page names (strings)
880
881 'PrefsEmailAudit': called when user changes his email address
882 $user: User (object) changing his email address
883 $oldaddr: old email address (string)
884 $newaddr: new email address (string)
885
886 'PrefsPasswordAudit': called when user changes his password
887 $user: User (object) changing his passoword
888 $newPass: new password
889 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
890
891 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
892 &$obj: RawPage object
893 &$text: The text that's going to be the output
894
895 'RecentChange_save': called at the end of RecenChange::save()
896 $recentChange: RecentChange object
897
898 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
899 $form: the PreferencesForm
900 $out: output page to render to, probably $wgOut
901
902 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
903 $form: the PreferencesForm
904 $user: the User object to load preferences from
905
906 'SavePreferences': called at the end of PreferencesForm::savePreferences;
907 returning false prevents the preferences from being saved.
908 $form: the PreferencesForm
909 $user: the User object to save preferences to
910 $message: change this to set an error message (ignored if the hook does notreturn fals)
911
912 'SearchUpdate': Prior to search update completion
913 $id : Page id
914 $namespace : Page namespace
915 $title : Page title
916 $text : Current text being indexed
917
918 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
919 $term : Search term string
920 &$title : Outparam; set to $title object and return false for a match
921
922 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
923 $text: Text being shown
924 $title: Title of the custom script/stylesheet page
925 $output: Current OutputPage object
926
927 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
928 &$siteNotice: HTML returned as the sitenotice
929 Return true to allow the normal method of notice selection/rendering to work,
930 or change the value of $siteNotice and return false to alter it.
931
932 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
933 &$siteNotice: HTML sitenotice
934 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
935
936 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
937 $skin: Skin object
938 &$text: bottomScripts Text
939 Append to $text to add additional text/scripts after the stock bottom scripts.
940
941 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
942 $skin: Skin object
943 &$subpages: Subpage links HTML
944 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
945 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
946
947 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
948 $sktemplate: SkinTemplate object
949 $content_actions: array of tabs
950
951 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
952 $sktemplate: SkinTemplate object
953 $nav_urls: array of tabs
954
955 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
956 &$content_actions: Content actions
957 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
958 for an example]
959
960 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
961 &$sktemplate: SkinTemplate object
962 &$tpl: Template engine object
963
964 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
965 $sktemplate: SkinTemplate object
966 $res: set to true to prevent active tabs
967
968 'SkinTemplateSetupPageCss': use this to provide per-page CSS
969 $out: Css to return
970
971 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
972 You can either create your own array, or alter the parameters for the normal one.
973 &$this: The SkinTemplate instance.
974 $title: Title instance for the page.
975 $message: Visible label of tab.
976 $selected: Whether this is a selected tab.
977 $checkEdit: Whether or not the action=edit query should be added if appropriate.
978 &$classes: Array of CSS classes to apply.
979 &$query: Query string to add to link.
980 &$text: Link text.
981 &$result: Complete assoc. array if you want to return true.
982
983 'SkinTemplateTabs': called when finished to build the actions tabs
984 $sktemplate: SkinTemplate object
985 $content_actions: array of tabs
986
987 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
988 $id: User identifier
989
990 'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
991 $pager: The UsersPager instance
992 $query: The query array to be returned
993
994 'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
995 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
996 $row: Database row object
997
998 'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
999 $pager: The UsersPager instance
1000 $out: The header HTML
1001
1002 'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
1003 $pager: The UsersPager instance
1004 $out: The header HTML
1005
1006 'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
1007 $pager: The UsersPager instance
1008 $query: The query array to be returned
1009
1010 'SpecialMovepageAfterMove': called after moving a page
1011 $movePage: MovePageForm object
1012 $oldTitle: old title (object)
1013 $newTitle: new title (object)
1014
1015 'SpecialPageExecuteAfterPage': called after executing a special page
1016 Warning: Not all the special pages call this hook
1017 $specialPage: SpecialPage object
1018 $par: paramter passed to the special page (string)
1019 $funct: function called to execute the special page
1020
1021 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
1022 Warning: Not all the special pages call this hook
1023 $specialPage: SpecialPage object
1024 $par: paramter passed to the special page (string)
1025 $funct: function called to execute the special page
1026
1027 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
1028 Warning: Not all the special pages call this hook
1029 $specialPage: SpecialPage object
1030 $par: paramter passed to the special page (string)
1031 $funct: function called to execute the special page
1032
1033 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
1034 $list: list (array) of core special pages
1035
1036 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
1037 $title: title object generated from the text entred by the user
1038
1039 'SpecialSearchResults': called before search result display when there are matches
1040 $term: string of search term
1041 $titleMatches: empty or SearchResultSet object
1042 $textMatches: empty or SearchResultSet object
1043
1044 'SpecialSearchNoResults': called before search result display when there are no matches
1045 $term: string of search term
1046
1047 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1048 $extTypes: associative array of extensions types
1049
1050 'TitleMoveComplete': after moving an article (title)
1051 $old: old title
1052 $nt: new title
1053 $user: user who did the move
1054 $pageid: database ID of the page that's been moved
1055 $redirid: database ID of the created redirect
1056
1057 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1058 $title: title object related to the revision
1059 $rev: revision (object) that will be viewed
1060
1061 'UnknownAction': An unknown "action" has occured (useful for defining
1062 your own actions)
1063 $action: action name
1064 $article: article "acted on"
1065
1066 'UnwatchArticle': before a watch is removed from an article
1067 $user: user watching
1068 $article: article object to be removed
1069
1070 'UnwatchArticle': after a watch is removed from an article
1071 $user: user that was watching
1072 $article: article object removed
1073
1074 'UnwatchArticleComplete': after a watch is removed from an article
1075 $user: user that watched
1076 $article: article object that was watched
1077
1078 'UploadForm:initial': before the upload form is generated
1079 $form: UploadForm object
1080 You might set the member-variables $uploadFormTextTop and
1081 $uploadFormTextAfterSummary to inject text (HTML) either before
1082 or after the editform.
1083
1084 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1085 $form: UploadForm object
1086 Lets you poke at member variables like $mUploadDescription before the
1087 file is saved.
1088
1089 'UploadVerification': additional chances to reject an uploaded file
1090 string $saveName: destination file name
1091 string $tempName: filesystem path to the temporary file for checks
1092 string &$error: output: HTML error to show if upload canceled by returning false
1093
1094 'UploadComplete': Upon completion of a file upload
1095 $uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
1096
1097 'userCan': To interrupt/advise the "user can do X to Y article" check.
1098 If you want to display an error message, try getUserPermissionsErrors.
1099 $title: Title object being checked against
1100 $user : Current user object
1101 $action: Action being checked
1102 $result: Pointer to result returned if hook returns false. If null is returned,
1103 userCan checks are continued by internal code.
1104
1105 'UserCanSendEmail': To override User::canSendEmail() permission check
1106 $user: User (object) whose permission is being checked
1107 &$canSend: bool set on input, can override on output
1108
1109
1110 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1111 $user: User (object) that'll clear the message
1112
1113 'UserCreateForm': change to manipulate the login form
1114 $template: SimpleTemplate instance for the form
1115
1116 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1117 $user: User to get groups for
1118 &$groups: Current effective groups
1119
1120 'UserLoginComplete': after a user has logged in
1121 $user: the user object that was created on login
1122
1123 'UserLoginForm': change to manipulate the login form
1124 $template: SimpleTemplate instance for the form
1125
1126 'UserLogout': before a user logs out
1127 $user: the user object that is about to be logged out
1128
1129 'UserLogoutComplete': after a user has logged out
1130 $user: the user object _after_ logout (won't have name, ID, etc.)
1131
1132 'UserRights': After a user's group memberships are changed
1133 $user : User object that was changed
1134 $add : Array of strings corresponding to groups added
1135 $remove: Array of strings corresponding to groups removed
1136
1137 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1138 &$groups: List of implicit (automatically-assigned) groups
1139
1140 'UserGetRights': Called in User::getRights()
1141 $user: User to get rights for
1142 &$rights: Current rights
1143
1144 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1145 $user: user retrieving new talks messages
1146 $talks: array of new talks page(s)
1147
1148 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1149 $toggles: array of toggles to add
1150
1151 'WatchArticle': before a watch is added to an article
1152 $user: user that will watch
1153 $article: article object to be watched
1154
1155 'WatchArticleComplete': after a watch is added to an article
1156 $user: user that watched
1157 $article: article object watched
1158
1159 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1160 $query: $wgQueryPages itself
1161
1162 More hooks might be available but undocumented, you can execute
1163 ./maintenance/findhooks.php to find hidden one.