Move initial connection checks into their own function.
[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
261 'AjaxAddScript': Called in output page just before the initialisation
262 of the javascript ajax engine. The hook is only called when ajax
263 is enabled ( $wgUseAjax = true; ).
264
265 'AlternateEdit': before checking if an user can edit a page and
266 before showing the edit form ( EditPage::edit() ). This is triggered
267 on &action=edit.
268 $EditPage : the EditPage object
269
270 'ArticleAfterFetchContent': after fetching content of an article from the database
271 $article: the article (object) being loaded from the database
272 $content: the content (string) of the article
273
274 'ArticleDelete': before an article is deleted
275 $article: the article (object) being deleted
276 $user: the user (object) deleting the article
277 $reason: the reason (string) the article is being deleted
278
279 'ArticleDeleteComplete': after an article is deleted
280 $article: the article that was deleted
281 $user: the user that deleted the article
282 $reason: the reason the article was deleted
283
284 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
285 $article: article (object) of the user talk page
286
287 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
288 $article: article (object) being modified
289
290 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
291 $title: title (object) used to create the article object
292 $article: article (object) that will be returned
293
294 'ArticleInsertComplete': After an article is created
295 $article: Article created
296 $user: User creating the article
297 $text: New content
298 $summary: Edit summary/comment
299 $isMinor: Whether or not the edit was marked as minor
300 $isWatch: (No longer used)
301 $section: (No longer used)
302 $flags: Flags passed to Article::doEdit()
303 $revision: New Revision of the article
304
305 'ArticleMergeComplete': after merging to article using Special:Mergehistory
306 $targetTitle: target title (object)
307 $destTitle: destination title (object)
308
309 'ArticlePageDataAfter': after loading data of an article from the database
310 $article: article (object) whose data were loaded
311 $row: row (object) returned from the database server
312
313 'ArticlePageDataBefore': before loading data of an article from the database
314 $article: article (object) that data will be loaded
315 $fields: fileds (array) to load from the database
316
317 'ArticleProtect': before an article is protected
318 $article: the article being protected
319 $user: the user doing the protection
320 $protect: boolean whether this is a protect or an unprotect
321 $reason: Reason for protect
322 $moveonly: boolean whether this is for move only or not
323
324 'ArticleProtectComplete': after an article is protected
325 $article: the article that was protected
326 $user: the user who did the protection
327 $protect: boolean whether it was a protect or an unprotect
328 $reason: Reason for protect
329 $moveonly: boolean whether it was for move only or not
330
331 'ArticlePurge': before executing "&action=purge"
332 $article: article (object) to purge
333
334 'ArticleRevisionUndeleted' after an article revision is restored
335 $title: the article title
336 $revision: the revision
337 $oldPageID: the page ID of the revision when archived (may be null)
338
339 'ArticleRollbackComplete': after an article rollback is completed
340 $article: the article that was edited
341 $user: the user who did the rollback
342 $revision: the revision the page was reverted back to
343
344 'ArticleSave': before an article is saved
345 $article: the article (object) being saved
346 $user: the user (object) saving the article
347 $text: the new article text
348 $summary: the article summary (comment)
349 $isminor: minor flag
350 $iswatch: watch flag
351 $section: section #
352
353 'ArticleSaveComplete': After an article has been updated
354 $article: Article modified
355 $user: User performing the modification
356 $text: New content
357 $summary: Edit summary/comment
358 $isMinor: Whether or not the edit was marked as minor
359 $isWatch: (No longer used)
360 $section: (No longer used)
361 $flags: Flags passed to Article::doEdit()
362 $revision: New Revision of the article
363
364 'ArticleSaveComplete': after an article is saved
365 $article: the article (object) saved
366 $user: the user (object) who saved the article
367 $text: the new article text
368 $summary: the article summary (comment)
369 $isminor: minor flag
370 $iswatch: watch flag
371 $section: section #
372
373 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
374
375 'ArticleUndelete': When one or more revisions of an article are restored
376 $title: Title corresponding to the article restored
377 $create: Whether or not the restoration caused the page to be created
378 (i.e. it didn't exist before)
379
380 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
381 &$article: the article
382 &$sectionanchor: The section anchor link (e.g. "#overview" )
383 &$extraq: Extra query parameters which can be added via hooked functions
384
385 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
386 &$article: the article
387 &$pcache: whether to try the parser cache or not
388 &$outputDone: whether the output for this page finished or not
389
390 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
391 $article: target article (object)
392
393 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
394 Gives a chance for an extension to set it programattically to a variable class.
395 &$auth: the $wgAuth object, probably a stub
396
397 'AutoAuthenticate': called to authenticate users on external/environmental means
398 $user: writes user object to this parameter
399
400 'BadImage': When checking against the bad image list
401 $name: Image name being checked
402 &$bad: Whether or not the image is "bad"
403
404 Change $bad and return false to override. If an image is "bad", it is not
405 rendered inline in wiki pages or galleries in category pages.
406
407 'BeforeGalleryFindFile': before an image is fetched for a gallery
408 &$gallery,: the gallery object
409 &$nt: the image title
410 &$time: image timestamp
411
412 'BeforePageDisplay': Prior to outputting a page
413 $out: OutputPage object
414
415 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
416 &$parser: Parser object
417 &$title: title of the template
418 &$skip: skip this template and link it?
419 &$id: the id of the revision being parsed
420
421 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
422 &$parser: Parser object
423 &$nt: the image title
424 &$skip: skip this image and link it?
425 &$time: the image timestamp
426
427 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
428 &$parser: Parser object
429 &$ig: ImageGallery object
430
431 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
432 $nondefaults: Assoc array with the following keys:
433 days, hideOwn, hideBots, hideMinor, namespace
434 $wgUser: wgUser.
435 &$hookSql: a string which will be inserted without sanitation into the SQL query
436 used to get the watchlist, at the end of the WHERE part.
437
438 'BlockIp': before an IP address or user is blocked
439 $block: the Block object about to be saved
440 $user: the user _doing_ the block (not the one being blocked)
441
442 'BlockIpComplete': after an IP address or user is blocked
443 $block: the Block object that was saved
444 $user: the user who did the block (not the one being blocked)
445
446 'BookInformation': Before information output on Special:Booksources
447 $isbn: ISBN to show information for
448 $output: OutputPage object in use
449
450 'CategoryPageView': before viewing a categorypage in CategoryPage::view
451 $catpage: CategoryPage instance
452
453 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
454 &$this: ChangesList instance.
455 &$articlelink: HTML of link to article (already filled-in).
456 &$s: HTML of row that is being constructed.
457 &$rc: RecentChange instance.
458 $unpatrolled: Whether or not we are showing unpatrolled changes.
459 $watched: Whether or not the change is watched by the user.
460
461 'ContributionsToolLinks': Change tool links above Special:Contributions
462 $id: User identifier
463 $title: User page title
464 &$tools: Array of tool links
465
466 'CustomEditor': When invoking the page editor
467 $article: Article being edited
468 $user: User performing the edit
469
470 Return true to allow the normal editor to be used, or false
471 if implementing a custom editor, e.g. for a special namespace,
472 etc.
473
474 'DiffViewHeader': called before diff display
475 $diff: DifferenceEngine object that's calling
476 $oldRev: Revision object of the "old" revision (may be null/invalid)
477 $newRev: Revision object of the "new" revision
478
479 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
480 $article: article (object) being viewed
481 $oldid: oldid (int) being viewed
482
483 'EditFilter': Perform checks on an edit
484 $editor: Edit form (see includes/EditPage.php)
485 $text: Contents of the edit box
486 $section: Section being edited
487 &$error: Error message to return
488
489 'EditFilterMerged': Post-section-merge edit filter
490 $editor: EditPage instance (object)
491 $text: content of the edit box
492 $error: error message to return
493
494 'EditFormPreloadText': Allows population of the edit form when creating new pages
495 &$text: Text to preload with
496 &$title: Title object representing the page being created
497
498 'EditPage::attemptSave': called before an article is
499 saved, that is before insertNewArticle() is called
500 &$editpage_Obj: the current EditPage object
501
502 'EditPage::showEditForm:fields': allows injection of form field into edit form
503 &$editor: the EditPage instance for reference
504 &$out: an OutputPage instance to write to
505 return value is ignored (should always return true)
506
507 'EditPage::showEditForm:initial': before showing the edit form
508 $editor: EditPage instance (object)
509
510 Return false to halt editing; you'll need to handle error messages, etc. yourself.
511 Alternatively, modifying $error and returning true will cause the contents of $error
512 to be echoed at the top of the edit form as wikitext. Return true without altering
513 $error to allow the edit to proceed.
514
515 'EditSectionLink': Override the return value of Linker::editSectionLink()
516 $skin: Skin rendering the UI
517 $title: Title being linked to
518 $section: Section to link to
519 $link: Default link
520 $result: Result (alter this to override the generated links)
521
522 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
523 $skin: Skin rendering the UI
524 $title: Title being linked to
525 $section: Section to link to
526 $hint: Anchor title/tooltip attributes
527 $link: Default link
528 $result: Result (alter this to override the generated links)
529
530 'EmailConfirmed': When checking that the user's email address is "confirmed"
531 $user: User being checked
532 $confirmed: Whether or not the email address is confirmed
533 This runs before the other checks, such as anonymity and the real check; return
534 true to allow those checks to occur, and false if checking is done.
535
536 'EmailUser': before sending email from one user to another
537 $to: address of receiving user
538 $from: address of sending user
539 $subject: subject of the mail
540 $text: text of the mail
541
542 'EmailUserComplete': after sending email from one user to another
543 $to: address of receiving user
544 $from: address of sending user
545 $subject: subject of the mail
546 $text: text of the mail
547
548 'FetchChangesList': When fetching the ChangesList derivative for a particular user
549 &$user: User the list is being fetched for
550 &$skin: Skin object to be used with the list
551 &$list: List object (defaults to NULL, change it to an object instance and return
552 false override the list derivative used)
553
554 'FileUpload': When a file upload occurs
555 $file : Image object representing the file that was uploaded
556
557 'GetBlockedStatus': after loading blocking status of an user from the database
558 $user: user (object) being checked
559
560 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
561 $title: Title object of page
562 $url: string value as output (out parameter, can modify)
563 $query: query options passed to Title::getFullURL()
564
565 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
566 $title: Title object of page
567 $url: string value as output (out parameter, can modify)
568 $query: query options passed to Title::getInternalURL()
569
570 'GetLinkColours': modify the CSS class of an array of page links
571 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
572 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
573
574 'GetLocalURL': modify local URLs as output into page links
575 $title: Title object of page
576 $url: string value as output (out parameter, can modify)
577 $query: query options passed to Title::getLocalURL()
578
579 'getUserPermissionsErrors': Add a permissions error when permissions errors are checked for.
580 Use instead of userCan for most cases. Return false if the user can't do it,
581 and populate $result with the reason in the form of array( messagename, param1, param2 )
582 $title: Title object being checked against
583 $user : Current user object
584 $action: Action being checked
585 $result: User permissions error to add. If none, return true.
586
587 'ImageOpenShowImageInlineBefore': Call potential extension just before showing the image on an image page
588 $imagePage: ImagePage object ($this)
589 $output: $wgOut
590
591 'InitPreferencesForm': called at the end of PreferencesForm's constructor
592 $form: the PreferencesForm
593 $request: the web request to initialized from
594
595 'InternalParseBeforeLinks': during Parser's internalParse method before links but
596 after noinclude/includeonly/onlyinclude and other processing.
597 &$this: Parser object
598 &$text: string containing partially parsed text
599 &$this->mStripState: Parser's internal StripState object
600
601 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
602 $article: article (object) being checked
603
604 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
605 $ip: IP being check
606 $result: Change this value to override the result of wfIsTrustedProxy()
607
608 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
609 tance to return false if the domain name doesn't match your organization
610 $addr: The e-mail address entered by the user
611 &$result: Set this and return false to override the internal checks
612
613 'isValidPassword': Override the result of User::isValidPassword()
614 $password: The password entered by the user
615 &$result: Set this and return false to override the internal checks
616 $user: User the password is being validated for
617
618 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
619 $magicExtensions: associative array of magic words synonyms
620 $lang: laguage code (string)
621
622 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
623 $specialPageAliases: associative array of magic words synonyms
624 $lang: laguage code (string)
625
626 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
627 &$linksUpdate: the LinkUpdate object
628
629 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
630
631 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
632
633 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
634 No return data is accepted; this hook is for auditing only.
635 $user: the User object being authenticated against
636 $password: the password being submitted and found wanting
637 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
638
639 'LogLine': Processes a single log entry on Special:Log
640 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
641 database field.
642 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
643 to logging.log_action database field.
644 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
645 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
646 appears to contain anything.
647 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
648 &$revert: string that is displayed in the UI, similar to $comment.
649
650 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
651 &$type: array of strings
652
653 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
654 &$typeText: array of strings
655
656 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
657 &$headerText: array of strings
658
659 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
660 &$actionText: array of strings
661
662 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
663 $magicWords: array of strings
664
665 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
666 $variableIDs: array of strings
667
668 'MarkPatrolled': before an edit is marked patrolled
669 $rcid: ID of the revision to be marked patrolled
670 $user: the user (object) marking the revision as patrolled
671 $wcOnlySysopsCanPatrol: config setting indicating whether the user
672 needs to be a sysop in order to mark an edit patrolled
673
674 'MarkPatrolledComplete': after an edit is marked patrolled
675 $rcid: ID of the revision marked as patrolled
676 $user: user (object) who marked the edit patrolled
677 $wcOnlySysopsCanPatrol: config setting indicating whether the user
678 must be a sysop to patrol the edit
679
680 'MathAfterTexvc': after texvc is executed when rendering mathematics
681 $mathRenderer: instance of MathRenderer
682 $errmsg: error message, in HTML (string). Nonempty indicates failure
683 of rendering the formula
684
685 'MediaWikiPerformAction': Override MediaWiki::performAction().
686 Use this to do something completely different, after the basic
687 globals have been set up, but before ordinary actions take place.
688 $output: $wgOut
689 $article: $wgArticle
690 $title: $wgTitle
691 $user: $wgUser
692 $request: $wgRequest
693
694 'MessagesPreLoad': When loading a message from the database
695 $title: title of the message (string)
696 $message: value (string), change it to the message you want to define
697
698 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
699 $tools: array of tools
700
701 'OutputPageBeforeHTML': a page has been processed by the parser and
702 the resulting HTML is about to be displayed.
703 $parserOutput: the parserOutput (object) that corresponds to the page
704 $text: the text that will be displayed, in HTML (string)
705
706 'OutputPageParserOutput': after adding a parserOutput to $wgOut
707 $out: OutputPage instance (object)
708 $parserOutput: parserOutput instance being added in $out
709
710 'PageHistoryBeforeList': When a history page list is about to be constructed.
711 $article: the article that the history is loading for
712
713 'PageHistoryLineEnding' : right before the end <li> is added to a history line
714 $row: the revision row for this line
715 $s: the string representing this parsed line
716
717 'PageRenderingHash': alter the parser cache option hash key
718 A parser extension which depends on user options should install
719 this hook and append its values to the key.
720 $hash: reference to a hash key string which can be modified
721
722 'ParserAfterStrip': Same as ParserBeforeStrip
723
724 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
725 $parser: Parser object being used
726 $text: text that'll be returned
727
728 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
729 $parser: Parser object
730 $text: text to parse
731 $stripState: StripState instance being used
732
733 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
734 $parser: parser object
735 $text: text being parsed
736 $stripState: stripState used (object)
737
738 'ParserBeforeTidy': called before tidy and custom tags replacements
739 $parser: Parser object being used
740 $text: actual text
741
742 'ParserClearState': called at the end of Parser::clearState()
743 $parser: Parser object being cleared
744
745 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
746 $parser: Parser object
747 $varCache: array to store the value in case of multiples calls of the same magic word
748 $index: index (string) of the magic
749 $ret: value of the magic word (the hook should set it)
750
751 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
752 $parser: Parser object
753 $time: actual time (timestamp)
754
755 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
756 $parser: Parser object
757 $varCache: varaiable cache (array)
758
759 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
760 $parser: Parser object
761 $limitReport: text that will be included (without comment tags)
762
763 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
764 $parser: Parser object created
765
766 'ParserTestTables': alter the list of tables to duplicate when parser tests
767 are run. Use when page save hooks require the presence of custom tables
768 to ensure that tests continue to run properly.
769 &$tables: array of table names
770
771 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
772 my talk page, my contributions" etc).
773
774 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
775 &$title: Title object representing the current page
776
777 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
778 &$user : User performing the action
779 $action : Action being performed
780 &$result : Whether or not the action should be prevented
781 Change $result and return false to give a definitive answer, otherwise
782 the built-in rate limiting checks are used, if enabled.
783
784 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
785 $form : PreferencesForm object
786 &$html : HTML to append to
787
788 'PrefsEmailAudit': called when user changes his email address
789 $user: User (object) changing his email address
790 $oldaddr: old email address (string)
791 $newaddr: new email address (string)
792
793 'PrefsPasswordAudit': called when user changes his password
794 $user: User (object) changing his passoword
795 $newPass: new password
796 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
797
798 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
799 &$obj: RawPage object
800 &$text: The text that's going to be the output
801
802 'RecentChange_save': called at the end of RecenChange::save()
803 $recentChange: RecentChange object
804
805 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
806 $form: the PreferencesForm
807 $out: output page to render to, probably $wgOut
808
809 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
810 $form: the PreferencesForm
811 $user: the User object to load preferences from
812
813 'SavePreferences': called at the end of PreferencesForm::savePreferences;
814 returning false prevents the preferences from being saved.
815 $form: the PreferencesForm
816 $user: the User object to save preferences to
817 $message: change this to set an error message (ignored if the hook does notreturn fals)
818
819 'SearchUpdate': Prior to search update completion
820 $id : Page id
821 $namespace : Page namespace
822 $title : Page title
823 $text : Current text being indexed
824
825 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
826 $text: Text being shown
827 $title: Title of the custom script/stylesheet page
828 $output: Current OutputPage object
829
830 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
831 &$siteNotice: HTML returned as the sitenotice
832 Return true to allow the normal method of notice selection/rendering to work,
833 or change the value of $siteNotice and return false to alter it.
834
835 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
836 &$siteNotice: HTML sitenotice
837 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
838
839 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
840 $skin: Skin object
841 &$text: bottomScripts Text
842 Append to $text to add additional text/scripts after the stock bottom scripts.
843
844 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
845 $sktemplate: SkinTemplate object
846 $content_actions: array of tabs
847
848 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
849 $sktemplate: SkinTemplate object
850 $nav_urls: array of tabs
851
852 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
853 &$content_actions: Content actions
854 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
855 for an example]
856
857 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
858 &$sktemplate: SkinTemplate object
859 &$tpl: Template engine object
860
861 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
862 $sktemplate: SkinTemplate object
863 $res: set to true to prevent active tabs
864
865 'SkinTemplateSetupPageCss': use this to provide per-page CSS
866 $out: Css to return
867
868 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
869 You can either create your own array, or alter the parameters for the normal one.
870 &$this: The SkinTemplate instance.
871 $title: Title instance for the page.
872 $message: Visible label of tab.
873 $selected: Whether this is a selected tab.
874 $checkEdit: Whether or not the action=edit query should be added if appropriate.
875 &$classes: Array of CSS classes to apply.
876 &$query: Query string to add to link.
877 &$text: Link text.
878 &$result: Complete assoc. array if you want to return true.
879
880 'SkinTemplateTabs': called when finished to build the actions tabs
881 $sktemplate: SkinTemplate object
882 $content_actions: array of tabs
883
884 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
885 $id: User identifier
886
887 'SpecialMovepageAfterMove': called after moving a page
888 $movePage: MovePageForm object
889 $oldTitle: old title (object)
890 $newTitle: new title (object)
891
892 'SpecialPageExecuteAfterPage': called after executing a special page
893 Warning: Not all the special pages call this hook
894 $specialPage: SpecialPage object
895 $par: paramter passed to the special page (string)
896 $funct: function called to execute the special page
897
898 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
899 Warning: Not all the special pages call this hook
900 $specialPage: SpecialPage object
901 $par: paramter passed to the special page (string)
902 $funct: function called to execute the special page
903
904 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
905 Warning: Not all the special pages call this hook
906 $specialPage: SpecialPage object
907 $par: paramter passed to the special page (string)
908 $funct: function called to execute the special page
909
910 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
911 $list: list (array) of core special pages
912
913 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
914 $title: title object generated from the text entred by the user
915
916 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
917 $extTypes: associative array of extensions types
918
919 'TitleMoveComplete': after moving an article (title)
920 $old: old title
921 $nt: new title
922 $user: user who did the move
923 $pageid: database ID of the page that's been moved
924 $redirid: database ID of the created redirect
925
926 'UndeleteShowRevision': called when showing a revision in Special:Undelete
927 $title: title object related to the revision
928 $rev: revision (object) that will be viewed
929
930 'UnknownAction': An unknown "action" has occured (useful for defining
931 your own actions)
932 $action: action name
933 $article: article "acted on"
934
935 'UnwatchArticle': before a watch is removed from an article
936 $user: user watching
937 $article: article object to be removed
938
939 'UnwatchArticle': after a watch is removed from an article
940 $user: user that was watching
941 $article: article object removed
942
943 'UnwatchArticleComplete': after a watch is removed from an article
944 $user: user that watched
945 $article: article object that was watched
946
947 'UploadForm:initial': before the upload form is generated
948 $form: UploadForm object
949 You might set the member-variables $uploadFormTextTop and
950 $uploadFormTextAfterSummary to inject text (HTML) either before
951 or after the editform.
952
953 'UploadForm:BeforeProcessing': at the beginning of processUpload()
954 $form: UploadForm object
955 Lets you poke at member variables like $mUploadDescription before the
956 file is saved.
957
958 'UploadVerification': additional chances to reject an uploaded file
959 string $saveName: destination file name
960 string $tempName: filesystem path to the temporary file for checks
961 string &$error: output: HTML error to show if upload canceled by returning false
962
963 'UploadComplete': Upon completion of a file upload
964 $image: Image object representing the file that was uploaded
965
966 'userCan': To interrupt/advise the "user can do X to Y article" check.
967 If you want to display an error message, try getUserPermissionsErrors.
968 $title: Title object being checked against
969 $user : Current user object
970 $action: Action being checked
971 $result: Pointer to result returned if hook returns false. If null is returned,
972 userCan checks are continued by internal code.
973
974 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
975 $user: User (object) that'll clear the message
976
977 'UserCreateForm': change to manipulate the login form
978 $template: SimpleTemplate instance for the form
979
980 'UserEffectiveGroups': Called in User::getEffectiveGroups()
981 $user: User to get groups for
982 &$groups: Current effective groups
983
984 'UserLoginComplete': after a user has logged in
985 $user: the user object that was created on login
986
987 'UserLoginForm': change to manipulate the login form
988 $template: SimpleTemplate instance for the form
989
990 'UserLogout': before a user logs out
991 $user: the user object that is about to be logged out
992
993 'UserLogoutComplete': after a user has logged out
994 $user: the user object _after_ logout (won't have name, ID, etc.)
995
996 'UserRights': After a user's group memberships are changed
997 $user : User object that was changed
998 $add : Array of strings corresponding to groups added
999 $remove: Array of strings corresponding to groups removed
1000
1001 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1002 &$groups: List of implicit (automatically-assigned) groups
1003
1004 'UserGetRights': Called in User::getRights()
1005 $user: User to get rights for
1006 &$rights: Current rights
1007
1008 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1009 $user: user retrieving new talks messages
1010 $talks: array of new talks page(s)
1011
1012 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1013 $toggles: array of toggles to add
1014
1015 'WatchArticle': before a watch is added to an article
1016 $user: user that will watch
1017 $article: article object to be watched
1018
1019 'WatchArticleComplete': after a watch is added to an article
1020 $user: user that watched
1021 $article: article object watched
1022
1023 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1024 $query: $wgQueryPages itself
1025
1026 More hooks might be available but undocumented, you can execute
1027 ./maintenance/findhooks.php to find hidden one.