Various final compatibility additions to work with global groups, which is ready...
[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 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
548 when there's an edit conflict. Return false to halt normal diff output; in
549 this case you're responsible for computing and outputting the entire "conflict"
550 part, i.e., the "difference between revisions" and "your text" headers and
551 sections.
552 &$editor: EditPage instance
553 &$out: OutputPage instance
554
555 'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form
556 &$editpage: The current EditPage object
557 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
558
559 'EditSectionLink': Override the return value of Linker::editSectionLink()
560 $skin: Skin rendering the UI
561 $title: Title being linked to
562 $section: Section to link to
563 $link: Default link
564 $result: Result (alter this to override the generated links)
565
566 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
567 $skin: Skin rendering the UI
568 $title: Title being linked to
569 $section: Section to link to
570 $hint: Anchor title/tooltip attributes
571 $link: Default link
572 $result: Result (alter this to override the generated links)
573
574 'EmailConfirmed': When checking that the user's email address is "confirmed"
575 $user: User being checked
576 $confirmed: Whether or not the email address is confirmed
577 This runs before the other checks, such as anonymity and the real check; return
578 true to allow those checks to occur, and false if checking is done.
579
580 'EmailUser': before sending email from one user to another
581 $to: address of receiving user
582 $from: address of sending user
583 $subject: subject of the mail
584 $text: text of the mail
585
586 'EmailUserComplete': after sending email from one user to another
587 $to: address of receiving user
588 $from: address of sending user
589 $subject: subject of the mail
590 $text: text of the mail
591
592 'FetchChangesList': When fetching the ChangesList derivative for a particular user
593 &$user: User the list is being fetched for
594 &$skin: Skin object to be used with the list
595 &$list: List object (defaults to NULL, change it to an object instance and return
596 false override the list derivative used)
597
598 'FileDeleteComplete': When a file is deleted
599 $file: reference to the deleted file
600 $oldimage: in case of the deletion of an old image, the name of the old file
601 $article: in case all revisions of the file are deleted a reference to the article
602 associated with the file.
603 $user: user who performed the deletion
604 $reason: reason
605
606 'FileUpload': When a file upload occurs
607 $file : Image object representing the file that was uploaded
608
609 'FileUndeleteComplete': When a file is undeleted
610 $title: title object to the file
611 $fileVersions: array of undeleted versions. Empty if all versions were restored
612 $user: user who performed the undeletion
613 $reason: reason
614
615 'GetAvailableRights': after calculating a list of all available rights
616 &$rights: Array of rights, which may be added to.
617
618 'GetBlockedStatus': after loading blocking status of an user from the database
619 $user: user (object) being checked
620
621 'GetCacheVaryCookies': get cookies that should vary cache options
622 $out: OutputPage object
623 &$cookies: array of cookies name, add a value to it if you want to add a cookie
624 that have to vary cache options
625
626 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
627 $title: Title object of page
628 $url: string value as output (out parameter, can modify)
629 $query: query options passed to Title::getFullURL()
630
631 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
632 $title: Title object of page
633 $url: string value as output (out parameter, can modify)
634 $query: query options passed to Title::getInternalURL()
635
636 'GetLinkColours': modify the CSS class of an array of page links
637 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
638 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
639
640 'GetLocalURL': modify local URLs as output into page links
641 $title: Title object of page
642 $url: string value as output (out parameter, can modify)
643 $query: query options passed to Title::getLocalURL()
644
645 'getUserPermissionsErrors': Add a permissions error when permissions errors are
646 checked for. Use instead of userCan for most cases. Return false if the
647 user can't do it, and populate $result with the reason in the form of
648 array( messagename, param1, param2, ... ). For consistency, error messages
649 should be plain text with no special coloring, bolding, etc. to show that
650 they're errors; presenting them properly to the user as errors is done by
651 the caller.
652 $title: Title object being checked against
653 $user : Current user object
654 $action: Action being checked
655 $result: User permissions error to add. If none, return true.
656
657 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
658 if expensive checks are enabled.
659
660 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
661 the image on an image page
662 $imagePage: ImagePage object ($this)
663 $output: $wgOut
664
665 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
666 image insertion. You can skip the default logic entirely by returning
667 false, or just modify a few things using call-by-reference.
668 &$this: Skin object
669 &$title: Title object of the image
670 &$file: File object, or false if it doesn't exist
671 &$frameParams: Various parameters with special meanings; see documentation in
672 includes/Linker.php for Linker::makeImageLink2
673 &$handlerParams: Various parameters with special meanings; see documentation in
674 includes/Linker.php for Linker::makeImageLink2
675 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
676 &$res: Final HTML output, used if you return false
677
678 'InitPreferencesForm': called at the end of PreferencesForm's constructor
679 $form: the PreferencesForm
680 $request: the web request to initialized from
681
682 'InternalParseBeforeLinks': during Parser's internalParse method before links but
683 after noinclude/includeonly/onlyinclude and other processing.
684 &$this: Parser object
685 &$text: string containing partially parsed text
686 &$this->mStripState: Parser's internal StripState object
687
688 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
689 $article: article (object) being checked
690
691 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
692 $ip: IP being check
693 $result: Change this value to override the result of wfIsTrustedProxy()
694
695 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
696 tance to return false if the domain name doesn't match your organization
697 $addr: The e-mail address entered by the user
698 &$result: Set this and return false to override the internal checks
699
700 'isValidPassword': Override the result of User::isValidPassword()
701 $password: The password entered by the user
702 &$result: Set this and return false to override the internal checks
703 $user: User the password is being validated for
704
705 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
706 $magicExtensions: associative array of magic words synonyms
707 $lang: laguage code (string)
708
709 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
710 $specialPageAliases: associative array of magic words synonyms
711 $lang: laguage code (string)
712
713 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
714 &$linksUpdate: the LinkUpdate object
715
716 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
717 &$linksUpdate: the LinkUpdate object
718
719 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
720 &$linksUpdate: the LinkUpdate object
721
722 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
723
724 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
725
726 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
727 No return data is accepted; this hook is for auditing only.
728 $user: the User object being authenticated against
729 $password: the password being submitted and found wanting
730 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
731
732 'LogLine': Processes a single log entry on Special:Log
733 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
734 database field.
735 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
736 to logging.log_action database field.
737 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
738 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
739 appears to contain anything.
740 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
741 &$revert: string that is displayed in the UI, similar to $comment.
742 $time: timestamp of the log entry (added in 1.12)
743
744 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
745 &$type: array of strings
746
747 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
748 &$typeText: array of strings
749
750 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
751 &$headerText: array of strings
752
753 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
754 &$actionText: array of strings
755
756 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
757 $magicWords: array of strings
758
759 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
760 $variableIDs: array of strings
761
762 'MarkPatrolled': before an edit is marked patrolled
763 $rcid: ID of the revision to be marked patrolled
764 $user: the user (object) marking the revision as patrolled
765 $wcOnlySysopsCanPatrol: config setting indicating whether the user
766 needs to be a sysop in order to mark an edit patrolled
767
768 'MarkPatrolledComplete': after an edit is marked patrolled
769 $rcid: ID of the revision marked as patrolled
770 $user: user (object) who marked the edit patrolled
771 $wcOnlySysopsCanPatrol: config setting indicating whether the user
772 must be a sysop to patrol the edit
773
774 'MathAfterTexvc': after texvc is executed when rendering mathematics
775 $mathRenderer: instance of MathRenderer
776 $errmsg: error message, in HTML (string). Nonempty indicates failure
777 of rendering the formula
778
779 'MediaWikiPerformAction': Override MediaWiki::performAction().
780 Use this to do something completely different, after the basic
781 globals have been set up, but before ordinary actions take place.
782 $output: $wgOut
783 $article: $wgArticle
784 $title: $wgTitle
785 $user: $wgUser
786 $request: $wgRequest
787
788 'MessagesPreLoad': When loading a message from the database
789 $title: title of the message (string)
790 $message: value (string), change it to the message you want to define
791
792 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
793 $tools: array of tools
794
795 'OutputPageBeforeHTML': a page has been processed by the parser and
796 the resulting HTML is about to be displayed.
797 $parserOutput: the parserOutput (object) that corresponds to the page
798 $text: the text that will be displayed, in HTML (string)
799
800 'OutputPageParserOutput': after adding a parserOutput to $wgOut
801 $out: OutputPage instance (object)
802 $parserOutput: parserOutput instance being added in $out
803
804 'PageHistoryBeforeList': When a history page list is about to be constructed.
805 $article: the article that the history is loading for
806
807 'PageHistoryLineEnding' : right before the end <li> is added to a history line
808 $row: the revision row for this line
809 $s: the string representing this parsed line
810
811 'PageRenderingHash': alter the parser cache option hash key
812 A parser extension which depends on user options should install
813 this hook and append its values to the key.
814 $hash: reference to a hash key string which can be modified
815
816 'ParserAfterStrip': Same as ParserBeforeStrip
817
818 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
819 $parser: Parser object being used
820 $text: text that'll be returned
821
822 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
823 $parser: Parser object
824 $text: text to parse
825 $stripState: StripState instance being used
826
827 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
828 $parser: parser object
829 $text: text being parsed
830 $stripState: stripState used (object)
831
832 'ParserBeforeTidy': called before tidy and custom tags replacements
833 $parser: Parser object being used
834 $text: actual text
835
836 'ParserClearState': called at the end of Parser::clearState()
837 $parser: Parser object being cleared
838
839 'ParserFirstCallInit': called when the parser initialises for the first time
840 &$parser: Parser object being cleared
841
842 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
843 $parser: Parser object
844 $varCache: array to store the value in case of multiples calls of the same magic word
845 $index: index (string) of the magic
846 $ret: value of the magic word (the hook should set it)
847
848 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
849 $parser: Parser object
850 $time: actual time (timestamp)
851
852 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
853 $parser: Parser object
854 $varCache: varaiable cache (array)
855
856 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
857 $parser: Parser object
858 $limitReport: text that will be included (without comment tags)
859
860 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
861 $title: title object representing the file
862 $file: file object that will be used to create the image
863 &$params: 2-D array of parameters
864
865 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
866 $parser: Parser object created
867
868 'ParserTestTables': alter the list of tables to duplicate when parser tests
869 are run. Use when page save hooks require the presence of custom tables
870 to ensure that tests continue to run properly.
871 &$tables: array of table names
872
873 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
874 my talk page, my contributions" etc).
875
876 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
877 &$title: Title object representing the current page
878
879 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
880 &$user : User performing the action
881 $action : Action being performed
882 &$result : Whether or not the action should be prevented
883 Change $result and return false to give a definitive answer, otherwise
884 the built-in rate limiting checks are used, if enabled.
885
886 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
887 $form : PreferencesForm object
888 &$html : HTML to append to
889
890 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
891 AJAX search suggestions. Put results into &$results outparam and return false.
892 $ns : array of int namespace keys to search in
893 $search : search term (not guaranteed to be conveniently normalized)
894 $limit : maximum number of results to return
895 &$results : out param: array of page names (strings)
896
897 'PrefsEmailAudit': called when user changes his email address
898 $user: User (object) changing his email address
899 $oldaddr: old email address (string)
900 $newaddr: new email address (string)
901
902 'PrefsPasswordAudit': called when user changes his password
903 $user: User (object) changing his passoword
904 $newPass: new password
905 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
906
907 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
908 &$obj: RawPage object
909 &$text: The text that's going to be the output
910
911 'RecentChange_save': called at the end of RecenChange::save()
912 $recentChange: RecentChange object
913
914 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
915 $form: the PreferencesForm
916 $out: output page to render to, probably $wgOut
917
918 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
919 $form: the PreferencesForm
920 $user: the User object to load preferences from
921
922 'RevisionInsertComplete': called after a revision is inserted into the DB
923 $revision: the Revision
924
925 'SavePreferences': called at the end of PreferencesForm::savePreferences;
926 returning false prevents the preferences from being saved.
927 $form: the PreferencesForm
928 $user: the User object to save preferences to
929 $message: change this to set an error message (ignored if the hook does not return false)
930 $old: old preferences of the user
931
932 'SearchUpdate': Prior to search update completion
933 $id : Page id
934 $namespace : Page namespace
935 $title : Page title
936 $text : Current text being indexed
937
938 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
939 $term : Search term string
940 &$title : Outparam; set to $title object and return false for a match
941
942 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
943 $text: Text being shown
944 $title: Title of the custom script/stylesheet page
945 $output: Current OutputPage object
946
947 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
948 &$siteNotice: HTML returned as the sitenotice
949 Return true to allow the normal method of notice selection/rendering to work,
950 or change the value of $siteNotice and return false to alter it.
951
952 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
953 &$siteNotice: HTML sitenotice
954 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
955
956 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
957 $skin: Skin object
958 &$text: bottomScripts Text
959 Append to $text to add additional text/scripts after the stock bottom scripts.
960
961 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
962 $skin: Skin object
963 &$subpages: Subpage links HTML
964 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
965 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
966
967 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
968 $sktemplate: SkinTemplate object
969 $content_actions: array of tabs
970
971 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
972 $sktemplate: SkinTemplate object
973 $nav_urls: array of tabs
974
975 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
976 &$content_actions: Content actions
977 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
978 for an example]
979
980 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
981 &$sktemplate: SkinTemplate object
982 &$tpl: Template engine object
983
984 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
985 $sktemplate: SkinTemplate object
986 $res: set to true to prevent active tabs
987
988 'SkinTemplateSetupPageCss': use this to provide per-page CSS
989 $out: Css to return
990
991 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
992 You can either create your own array, or alter the parameters for the normal one.
993 &$this: The SkinTemplate instance.
994 $title: Title instance for the page.
995 $message: Visible label of tab.
996 $selected: Whether this is a selected tab.
997 $checkEdit: Whether or not the action=edit query should be added if appropriate.
998 &$classes: Array of CSS classes to apply.
999 &$query: Query string to add to link.
1000 &$text: Link text.
1001 &$result: Complete assoc. array if you want to return true.
1002
1003 'SkinTemplateTabs': called when finished to build the actions tabs
1004 $sktemplate: SkinTemplate object
1005 $content_actions: array of tabs
1006
1007 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1008 $id: User identifier
1009
1010 'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
1011 $pager: The UsersPager instance
1012 $query: The query array to be returned
1013
1014 'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
1015 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1016 $row: Database row object
1017
1018 'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
1019 $pager: The UsersPager instance
1020 $out: The header HTML
1021
1022 'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
1023 $pager: The UsersPager instance
1024 $out: The header HTML
1025
1026 'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
1027 $pager: The UsersPager instance
1028 $query: The query array to be returned
1029
1030 'SpecialMovepageAfterMove': called after moving a page
1031 $movePage: MovePageForm object
1032 $oldTitle: old title (object)
1033 $newTitle: new title (object)
1034
1035 'SpecialPageExecuteAfterPage': called after executing a special page
1036 Warning: Not all the special pages call this hook
1037 $specialPage: SpecialPage object
1038 $par: paramter passed to the special page (string)
1039 $funct: function called to execute the special page
1040
1041 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
1042 Warning: Not all the special pages call this hook
1043 $specialPage: SpecialPage object
1044 $par: paramter passed to the special page (string)
1045 $funct: function called to execute the special page
1046
1047 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
1048 Warning: Not all the special pages call this hook
1049 $specialPage: SpecialPage object
1050 $par: paramter passed to the special page (string)
1051 $funct: function called to execute the special page
1052
1053 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
1054 $list: list (array) of core special pages
1055
1056 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
1057 $title: title object generated from the text entred by the user
1058
1059 'SpecialSearchResults': called before search result display when there are matches
1060 $term: string of search term
1061 $titleMatches: empty or SearchResultSet object
1062 $textMatches: empty or SearchResultSet object
1063
1064 'SpecialSearchNoResults': called before search result display when there are no matches
1065 $term: string of search term
1066
1067 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1068 $extTypes: associative array of extensions types
1069
1070 'TitleMoveComplete': after moving an article (title)
1071 $old: old title
1072 $nt: new title
1073 $user: user who did the move
1074 $pageid: database ID of the page that's been moved
1075 $redirid: database ID of the created redirect
1076
1077 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1078 $title: title object related to the revision
1079 $rev: revision (object) that will be viewed
1080
1081 'UnknownAction': An unknown "action" has occured (useful for defining
1082 your own actions)
1083 $action: action name
1084 $article: article "acted on"
1085
1086 'UnwatchArticle': before a watch is removed from an article
1087 $user: user watching
1088 $article: article object to be removed
1089
1090 'UnwatchArticle': after a watch is removed from an article
1091 $user: user that was watching
1092 $article: article object removed
1093
1094 'UnwatchArticleComplete': after a watch is removed from an article
1095 $user: user that watched
1096 $article: article object that was watched
1097
1098 'UploadForm:initial': before the upload form is generated
1099 $form: UploadForm object
1100 You might set the member-variables $uploadFormTextTop and
1101 $uploadFormTextAfterSummary to inject text (HTML) either before
1102 or after the editform.
1103
1104 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1105 $form: UploadForm object
1106 Lets you poke at member variables like $mUploadDescription before the
1107 file is saved.
1108
1109 'UploadVerification': additional chances to reject an uploaded file
1110 string $saveName: destination file name
1111 string $tempName: filesystem path to the temporary file for checks
1112 string &$error: output: HTML error to show if upload canceled by returning false
1113
1114 'UploadComplete': Upon completion of a file upload
1115 $uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
1116
1117 'UserArrayFromResult': called when creating an UserArray object from a database result
1118 &$userArray: set this to an object to override the default object returned
1119 $res: database result used to create the object
1120
1121 'userCan': To interrupt/advise the "user can do X to Y article" check.
1122 If you want to display an error message, try getUserPermissionsErrors.
1123 $title: Title object being checked against
1124 $user : Current user object
1125 $action: Action being checked
1126 $result: Pointer to result returned if hook returns false. If null is returned,
1127 userCan checks are continued by internal code.
1128
1129 'UserCanSendEmail': To override User::canSendEmail() permission check
1130 $user: User (object) whose permission is being checked
1131 &$canSend: bool set on input, can override on output
1132
1133
1134 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1135 $user: User (object) that'll clear the message
1136
1137 'UserCreateForm': change to manipulate the login form
1138 $template: SimpleTemplate instance for the form
1139
1140 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1141 $user: User to get groups for
1142 &$groups: Current effective groups
1143
1144 'UserGetEmail': called when getting an user email address
1145 $user: User object
1146 &$email: email, change this to override local email
1147
1148 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of email authentification
1149 $user: User object
1150 &$timestamp: timestamp, change this to override local email authentification timestamp
1151
1152 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1153 &$groups: List of implicit (automatically-assigned) groups
1154
1155 'UserGetRights': Called in User::getRights()
1156 $user: User to get rights for
1157 &$rights: Current rights
1158
1159 'UserLoginComplete': after a user has logged in
1160 $user: the user object that was created on login
1161 $inject_html: Any HTML to inject after the "logged in" message.
1162
1163 'UserLoginForm': change to manipulate the login form
1164 $template: SimpleTemplate instance for the form
1165
1166 'UserLogout': before a user logs out
1167 $user: the user object that is about to be logged out
1168
1169 'UserLogoutComplete': after a user has logged out
1170 $user: the user object _after_ logout (won't have name, ID, etc.)
1171 $inject_html: Any HTML to inject after the "logged out" message.
1172
1173 'UserRights': After a user's group memberships are changed
1174 $user : User object that was changed
1175 $add : Array of strings corresponding to groups added
1176 $remove: Array of strings corresponding to groups removed
1177
1178 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1179 $user: user retrieving new talks messages
1180 $talks: array of new talks page(s)
1181
1182 'UserSaveSettings': called when saving user settings
1183 $user: User object
1184
1185 'UserSetEmail': called when changing user email address
1186 $user: User object
1187 &$email: new email, change this to override new email address
1188
1189 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp of email authentification
1190 $user: User object
1191 &$timestamp: new timestamp, change this to override local email authentification timestamp
1192
1193 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1194 $toggles: array of toggles to add
1195
1196 'WatchArticle': before a watch is added to an article
1197 $user: user that will watch
1198 $article: article object to be watched
1199
1200 'WatchArticleComplete': after a watch is added to an article
1201 $user: user that watched
1202 $article: article object watched
1203
1204 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1205 $query: $wgQueryPages itself
1206
1207 More hooks might be available but undocumented, you can execute
1208 ./maintenance/findhooks.php to find hidden one.