Improve efficiency of autoreviewing of edits rollbacks and merge into main 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 $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 $id: id of the article that was deleted
293
294 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
295 $article: article (object) of the user talk page
296
297 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
298 $article: article (object) being modified
299
300 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
301 $title: title (object) used to create the article object
302 $article: article (object) that will be returned
303
304 'ArticleInsertComplete': After an article is created
305 $article: Article created
306 $user: User creating the article
307 $text: New content
308 $summary: Edit summary/comment
309 $isMinor: Whether or not the edit was marked as minor
310 $isWatch: (No longer used)
311 $section: (No longer used)
312 $flags: Flags passed to Article::doEdit()
313 $revision: New Revision of the article
314
315 'ArticleMergeComplete': after merging to article using Special:Mergehistory
316 $targetTitle: target title (object)
317 $destTitle: destination title (object)
318
319 'ArticlePageDataAfter': after loading data of an article from the database
320 $article: article (object) whose data were loaded
321 $row: row (object) returned from the database server
322
323 'ArticlePageDataBefore': before loading data of an article from the database
324 $article: article (object) that data will be loaded
325 $fields: fileds (array) to load from the database
326
327 'ArticleProtect': before an article is protected
328 $article: the article being protected
329 $user: the user doing the protection
330 $protect: boolean whether this is a protect or an unprotect
331 $reason: Reason for protect
332 $moveonly: boolean whether this is for move only or not
333
334 'ArticleProtectComplete': after an article is protected
335 $article: the article that was protected
336 $user: the user who did the protection
337 $protect: boolean whether it was a protect or an unprotect
338 $reason: Reason for protect
339 $moveonly: boolean whether it was for move only or not
340
341 'ArticlePurge': before executing "&action=purge"
342 $article: article (object) to purge
343
344 'ArticleRevisionVisiblitySet': called when changing visibility of one or more
345 revision of an article
346 &$title: title object of the article
347
348 'ArticleRevisionUndeleted': after an article revision is restored
349 $title: the article title
350 $revision: the revision
351 $oldPageID: the page ID of the revision when archived (may be null)
352
353 'ArticleRollbackComplete': after an article rollback is completed
354 $article: the article that was edited
355 $user: the user who did the rollback
356 $revision: the revision the page was reverted back to
357
358 'ArticleSave': before an article is saved
359 $article: the article (object) being saved
360 $user: the user (object) saving the article
361 $text: the new article text
362 $summary: the article summary (comment)
363 $isminor: minor flag
364 $iswatch: watch flag
365 $section: section #
366
367 'ArticleSaveComplete': After an article has been updated
368 $article: Article modified
369 $user: User performing the modification
370 $text: New content
371 $summary: Edit summary/comment
372 $isMinor: Whether or not the edit was marked as minor
373 $isWatch: (No longer used)
374 $section: (No longer used)
375 $flags: Flags passed to Article::doEdit()
376 $revision: New Revision of the article
377
378 'ArticleSaveComplete': after an article is saved
379 $article: the article (object) saved
380 $user: the user (object) who saved the article
381 $text: the new article text
382 $summary: the article summary (comment)
383 $isminor: minor flag
384 $iswatch: watch flag
385 $section: section #
386
387 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
388
389 'ArticleUndelete': When one or more revisions of an article are restored
390 $title: Title corresponding to the article restored
391 $create: Whether or not the restoration caused the page to be created
392 (i.e. it didn't exist before)
393
394 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
395 &$article: the article
396 &$sectionanchor: The section anchor link (e.g. "#overview" )
397 &$extraq: Extra query parameters which can be added via hooked functions
398
399 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
400 &$article: the article
401 &$pcache: whether to try the parser cache or not
402 &$outputDone: whether the output for this page finished or not
403
404 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
405 $article: target article (object)
406
407 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
408 Gives a chance for an extension to set it programattically to a variable class.
409 &$auth: the $wgAuth object, probably a stub
410
411 'AutopromoteCondition': check autopromote condition for user.
412 $type: condition type
413 $args: arguments
414 $user: user
415 $result: result of checking autopromote condition
416
417 'BadImage': When checking against the bad image list
418 $name: Image name being checked
419 &$bad: Whether or not the image is "bad"
420
421 Change $bad and return false to override. If an image is "bad", it is not
422 rendered inline in wiki pages or galleries in category pages.
423
424 'BeforeGalleryFindFile': before an image is fetched for a gallery
425 &$gallery,: the gallery object
426 &$nt: the image title
427 &$time: image timestamp
428
429 'BeforePageDisplay': Prior to outputting a page
430 &$out: OutputPage object
431 &$skin: Skin object
432
433 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
434 &$parser: Parser object
435 &$title: title of the template
436 &$skip: skip this template and link it?
437 &$id: the id of the revision being parsed
438
439 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
440 &$parser: Parser object
441 &$nt: the image title
442 &$skip: skip this image and link it?
443 &$time: the image timestamp
444
445 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
446 &$parser: Parser object
447 &$ig: ImageGallery object
448
449 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
450 $nondefaults: Assoc array with the following keys:
451 days, hideOwn, hideBots, hideMinor, namespace
452 $wgUser: wgUser.
453 &$hookSql: a string which will be inserted without sanitation into the SQL query
454 used to get the watchlist, at the end of the WHERE part.
455
456 'BlockIp': before an IP address or user is blocked
457 $block: the Block object about to be saved
458 $user: the user _doing_ the block (not the one being blocked)
459
460 'BlockIpComplete': after an IP address or user is blocked
461 $block: the Block object that was saved
462 $user: the user who did the block (not the one being blocked)
463
464 'BookInformation': Before information output on Special:Booksources
465 $isbn: ISBN to show information for
466 $output: OutputPage object in use
467
468 'BrokenLink': Before the HTML is created for a broken (i.e. red) link
469 &$linker: Linker instance
470 $nt: the page title
471 $query: the URL query string passed in
472 &$u: the URL of this link
473 &$style: the inline CSS style
474 &$prefix: a prefix prepended to the linked text
475 &$text: the text placed by the user in the wiki-link
476 &$inside: any additional alphanumeric characters placed after the wiki-link,
477 that are made part of the link text
478 &$trail: text placed immediately after the HTML link
479
480 'CategoryPageView': before viewing a categorypage in CategoryPage::view
481 $catpage: CategoryPage instance
482
483 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
484 &$this: ChangesList instance.
485 &$articlelink: HTML of link to article (already filled-in).
486 &$s: HTML of row that is being constructed.
487 &$rc: RecentChange instance.
488 $unpatrolled: Whether or not we are showing unpatrolled changes.
489 $watched: Whether or not the change is watched by the user.
490
491 'ContributionsToolLinks': Change tool links above Special:Contributions
492 $id: User identifier
493 $title: User page title
494 &$tools: Array of tool links
495
496 'CustomEditor': When invoking the page editor
497 $article: Article being edited
498 $user: User performing the edit
499
500 Return true to allow the normal editor to be used, or false
501 if implementing a custom editor, e.g. for a special namespace,
502 etc.
503
504 'DiffViewHeader': called before diff display
505 $diff: DifferenceEngine object that's calling
506 $oldRev: Revision object of the "old" revision (may be null/invalid)
507 $newRev: Revision object of the "new" revision
508
509 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
510 $article: article (object) being viewed
511 $oldid: oldid (int) being viewed
512
513 'EditFilter': Perform checks on an edit
514 $editor: Edit form (see includes/EditPage.php)
515 $text: Contents of the edit box
516 $section: Section being edited
517 &$error: Error message to return
518
519 'EditFilterMerged': Post-section-merge edit filter
520 $editor: EditPage instance (object)
521 $text: content of the edit box
522 $error: error message to return
523
524 'EditFormPreloadText': Allows population of the edit form when creating new pages
525 &$text: Text to preload with
526 &$title: Title object representing the page being created
527
528 'EditPage::attemptSave': called before an article is
529 saved, that is before insertNewArticle() is called
530 &$editpage_Obj: the current EditPage object
531
532 'EditPage::showEditForm:fields': allows injection of form field into edit form
533 &$editor: the EditPage instance for reference
534 &$out: an OutputPage instance to write to
535 return value is ignored (should always return true)
536
537 'EditPage::showEditForm:initial': before showing the edit form
538 $editor: EditPage instance (object)
539
540 Return false to halt editing; you'll need to handle error messages, etc. yourself.
541 Alternatively, modifying $error and returning true will cause the contents of $error
542 to be echoed at the top of the edit form as wikitext. Return true without altering
543 $error to allow the edit to proceed.
544
545 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
546 when there's an edit conflict. Return false to halt normal diff output; in
547 this case you're responsible for computing and outputting the entire "conflict"
548 part, i.e., the "difference between revisions" and "your text" headers and
549 sections.
550 &$editor: EditPage instance
551 &$out: OutputPage instance
552
553 'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form
554 &$editpage: The current EditPage object
555 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
556
557 'EditSectionLink': Override the return value of Linker::editSectionLink()
558 $skin: Skin rendering the UI
559 $title: Title being linked to
560 $section: Section to link to
561 $link: Default link
562 $result: Result (alter this to override the generated links)
563
564 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
565 $skin: Skin rendering the UI
566 $title: Title being linked to
567 $section: Section to link to
568 $hint: Anchor title/tooltip attributes
569 $link: Default link
570 $result: Result (alter this to override the generated links)
571
572 'EmailConfirmed': When checking that the user's email address is "confirmed"
573 $user: User being checked
574 $confirmed: Whether or not the email address is confirmed
575 This runs before the other checks, such as anonymity and the real check; return
576 true to allow those checks to occur, and false if checking is done.
577
578 'EmailUser': before sending email from one user to another
579 $to: address of receiving user
580 $from: address of sending user
581 $subject: subject of the mail
582 $text: text of the mail
583
584 'EmailUserComplete': after sending email from one user to another
585 $to: address of receiving user
586 $from: address of sending user
587 $subject: subject of the mail
588 $text: text of the mail
589
590 'FetchChangesList': When fetching the ChangesList derivative for a particular user
591 &$user: User the list is being fetched for
592 &$skin: Skin object to be used with the list
593 &$list: List object (defaults to NULL, change it to an object instance and return
594 false override the list derivative used)
595
596 'FileDeleteComplete': When a file is deleted
597 $file: reference to the deleted file
598 $oldimage: in case of the deletion of an old image, the name of the old file
599 $article: in case all revisions of the file are deleted a reference to the article
600 associated with the file.
601 $user: user who performed the deletion
602 $reason: reason
603
604 'FileUpload': When a file upload occurs
605 $file : Image object representing the file that was uploaded
606
607 'FileUndeleteComplete': When a file is undeleted
608 $title: title object to the file
609 $fileVersions: array of undeleted versions. Empty if all versions were restored
610 $user: user who performed the undeletion
611 $reason: reason
612
613 'GetBlockedStatus': after loading blocking status of an user from the database
614 $user: user (object) being checked
615
616 'GetCacheVaryCookies': get cookies that should vary cache options
617 $out: OutputPage object
618 &$cookies: array of cookies name, add a value to it if you want to add a cookie
619 that have to vary cache options
620
621 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
622 $title: Title object of page
623 $url: string value as output (out parameter, can modify)
624 $query: query options passed to Title::getFullURL()
625
626 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
627 $title: Title object of page
628 $url: string value as output (out parameter, can modify)
629 $query: query options passed to Title::getInternalURL()
630
631 'GetLinkColours': modify the CSS class of an array of page links
632 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
633 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
634
635 'GetLocalURL': modify local URLs as output into page links
636 $title: Title object of page
637 $url: string value as output (out parameter, can modify)
638 $query: query options passed to Title::getLocalURL()
639
640 'getUserPermissionsErrors': Add a permissions error when permissions errors are
641 checked for. Use instead of userCan for most cases. Return false if the
642 user can't do it, and populate $result with the reason in the form of
643 array( messagename, param1, param2, ... ). For consistency, error messages
644 should be plain text with no special coloring, bolding, etc. to show that
645 they're errors; presenting them properly to the user as errors is done by
646 the caller.
647 $title: Title object being checked against
648 $user : Current user object
649 $action: Action being checked
650 $result: User permissions error to add. If none, return true.
651
652 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
653 if expensive checks are enabled.
654
655 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
656 the image on an image page
657 $imagePage: ImagePage object ($this)
658 $output: $wgOut
659
660 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
661 image insertion. You can skip the default logic entirely by returning
662 false, or just modify a few things using call-by-reference.
663 &$this: Skin object
664 &$title: Title object of the image
665 &$file: File object, or false if it doesn't exist
666 &$frameParams: Various parameters with special meanings; see documentation in
667 includes/Linker.php for Linker::makeImageLink2
668 &$handlerParams: Various parameters with special meanings; see documentation in
669 includes/Linker.php for Linker::makeImageLink2
670 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
671 &$res: Final HTML output, used if you return false
672
673 'InitPreferencesForm': called at the end of PreferencesForm's constructor
674 $form: the PreferencesForm
675 $request: the web request to initialized from
676
677 'InternalParseBeforeLinks': during Parser's internalParse method before links but
678 after noinclude/includeonly/onlyinclude and other processing.
679 &$this: Parser object
680 &$text: string containing partially parsed text
681 &$this->mStripState: Parser's internal StripState object
682
683 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
684 $article: article (object) being checked
685
686 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
687 $ip: IP being check
688 $result: Change this value to override the result of wfIsTrustedProxy()
689
690 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
691 tance to return false if the domain name doesn't match your organization
692 $addr: The e-mail address entered by the user
693 &$result: Set this and return false to override the internal checks
694
695 'isValidPassword': Override the result of User::isValidPassword()
696 $password: The password entered by the user
697 &$result: Set this and return false to override the internal checks
698 $user: User the password is being validated for
699
700 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
701 $magicExtensions: associative array of magic words synonyms
702 $lang: laguage code (string)
703
704 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
705 $specialPageAliases: associative array of magic words synonyms
706 $lang: laguage code (string)
707
708 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
709 &$linksUpdate: the LinkUpdate object
710
711 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
712 &$linksUpdate: the LinkUpdate object
713
714 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
715 &$linksUpdate: the LinkUpdate object
716
717 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
718
719 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
720
721 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
722 No return data is accepted; this hook is for auditing only.
723 $user: the User object being authenticated against
724 $password: the password being submitted and found wanting
725 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
726
727 'LogLine': Processes a single log entry on Special:Log
728 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
729 database field.
730 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
731 to logging.log_action database field.
732 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
733 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
734 appears to contain anything.
735 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
736 &$revert: string that is displayed in the UI, similar to $comment.
737 $time: timestamp of the log entry (added in 1.12)
738
739 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
740 &$type: array of strings
741
742 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
743 &$typeText: array of strings
744
745 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
746 &$headerText: array of strings
747
748 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
749 &$actionText: array of strings
750
751 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
752 $magicWords: array of strings
753
754 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
755 $variableIDs: array of strings
756
757 'MarkPatrolled': before an edit is marked patrolled
758 $rcid: ID of the revision to be marked patrolled
759 $user: the user (object) marking the revision as patrolled
760 $wcOnlySysopsCanPatrol: config setting indicating whether the user
761 needs to be a sysop in order to mark an edit patrolled
762
763 'MarkPatrolledComplete': after an edit is marked patrolled
764 $rcid: ID of the revision marked as patrolled
765 $user: user (object) who marked the edit patrolled
766 $wcOnlySysopsCanPatrol: config setting indicating whether the user
767 must be a sysop to patrol the edit
768
769 'MathAfterTexvc': after texvc is executed when rendering mathematics
770 $mathRenderer: instance of MathRenderer
771 $errmsg: error message, in HTML (string). Nonempty indicates failure
772 of rendering the formula
773
774 'MediaWikiPerformAction': Override MediaWiki::performAction().
775 Use this to do something completely different, after the basic
776 globals have been set up, but before ordinary actions take place.
777 $output: $wgOut
778 $article: $wgArticle
779 $title: $wgTitle
780 $user: $wgUser
781 $request: $wgRequest
782
783 'MessagesPreLoad': When loading a message from the database
784 $title: title of the message (string)
785 $message: value (string), change it to the message you want to define
786
787 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
788 Note: this is only run for the Monobook skin. To add items to the toolbox
789 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
790 instead.
791 $tools: array of tools
792
793 'OutputPageBeforeHTML': a page has been processed by the parser and
794 the resulting HTML is about to be displayed.
795 $parserOutput: the parserOutput (object) that corresponds to the page
796 $text: the text that will be displayed, in HTML (string)
797
798 'OutputPageParserOutput': after adding a parserOutput to $wgOut
799 $out: OutputPage instance (object)
800 $parserOutput: parserOutput instance being added in $out
801
802 'PageHistoryBeforeList': When a history page list is about to be constructed.
803 $article: the article that the history is loading for
804
805 'PageHistoryLineEnding' : right before the end <li> is added to a history line
806 $row: the revision row for this line
807 $s: the string representing this parsed line
808
809 'PageRenderingHash': alter the parser cache option hash key
810 A parser extension which depends on user options should install
811 this hook and append its values to the key.
812 $hash: reference to a hash key string which can be modified
813
814 'ParserAfterStrip': Same as ParserBeforeStrip
815
816 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
817 $parser: Parser object being used
818 $text: text that'll be returned
819
820 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
821 $parser: Parser object
822 $text: text to parse
823 $stripState: StripState instance being used
824
825 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
826 $parser: parser object
827 $text: text being parsed
828 $stripState: stripState used (object)
829
830 'ParserBeforeTidy': called before tidy and custom tags replacements
831 $parser: Parser object being used
832 $text: actual text
833
834 'ParserClearState': called at the end of Parser::clearState()
835 $parser: Parser object being cleared
836
837 'ParserFirstCallInit': called when the parser initialises for the first time
838 &$parser: Parser object being cleared
839
840 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
841 $parser: Parser object
842 $varCache: array to store the value in case of multiples calls of the same magic word
843 $index: index (string) of the magic
844 $ret: value of the magic word (the hook should set it)
845
846 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
847 $parser: Parser object
848 $time: actual time (timestamp)
849
850 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
851 $parser: Parser object
852 $varCache: varaiable cache (array)
853
854 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
855 $parser: Parser object
856 $limitReport: text that will be included (without comment tags)
857
858 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
859 $title: title object representing the file
860 $file: file object that will be used to create the image
861 &$params: 2-D array of parameters
862
863 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
864 $parser: Parser object created
865
866 'ParserTestTables': alter the list of tables to duplicate when parser tests
867 are run. Use when page save hooks require the presence of custom tables
868 to ensure that tests continue to run properly.
869 &$tables: array of table names
870
871 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
872 my talk page, my contributions" etc).
873
874 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
875 &$title: Title object representing the current page
876
877 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
878 &$user : User performing the action
879 $action : Action being performed
880 &$result : Whether or not the action should be prevented
881 Change $result and return false to give a definitive answer, otherwise
882 the built-in rate limiting checks are used, if enabled.
883
884 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
885 $form : PreferencesForm object
886 &$html : HTML to append to
887
888 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
889 AJAX search suggestions. Put results into &$results outparam and return false.
890 $ns : array of int namespace keys to search in
891 $search : search term (not guaranteed to be conveniently normalized)
892 $limit : maximum number of results to return
893 &$results : out param: array of page names (strings)
894
895 'PrefsEmailAudit': called when user changes his email address
896 $user: User (object) changing his email address
897 $oldaddr: old email address (string)
898 $newaddr: new email address (string)
899
900 'PrefsPasswordAudit': called when user changes his password
901 $user: User (object) changing his passoword
902 $newPass: new password
903 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
904
905 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
906 &$obj: RawPage object
907 &$text: The text that's going to be the output
908
909 'RecentChange_save': called at the end of RecenChange::save()
910 $recentChange: RecentChange object
911
912 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
913 $form: the PreferencesForm
914 $out: output page to render to, probably $wgOut
915
916 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
917 $form: the PreferencesForm
918 $user: the User object to load preferences from
919
920 'RevisionInsertComplete': called after a revision is inserted into the DB
921 $revision: the Revision
922 $edit: was this a new edit?
923 $baseID: what revision ID was this revision based off? (false if none)
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 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have been rendered (useful for adding more)
1008 $tools: array of tools
1009
1010 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1011 $id: User identifier
1012
1013 'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
1014 $pager: The UsersPager instance
1015 $query: The query array to be returned
1016
1017 'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
1018 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1019 $row: Database row object
1020
1021 'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
1022 $pager: The UsersPager instance
1023 $out: The header HTML
1024
1025 'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
1026 $pager: The UsersPager instance
1027 $out: The header HTML
1028
1029 'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
1030 $pager: The UsersPager instance
1031 $query: The query array to be returned
1032
1033 'SpecialMovepageAfterMove': called after moving a page
1034 $movePage: MovePageForm object
1035 $oldTitle: old title (object)
1036 $newTitle: new title (object)
1037
1038 'SpecialPageExecuteAfterPage': called after executing a special page
1039 Warning: Not all the special pages call this hook
1040 $specialPage: SpecialPage object
1041 $par: paramter passed to the special page (string)
1042 $funct: function called to execute the special page
1043
1044 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
1045 Warning: Not all the special pages call this hook
1046 $specialPage: SpecialPage object
1047 $par: paramter passed to the special page (string)
1048 $funct: function called to execute the special page
1049
1050 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
1051 Warning: Not all the special pages call this hook
1052 $specialPage: SpecialPage object
1053 $par: paramter passed to the special page (string)
1054 $funct: function called to execute the special page
1055
1056 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
1057 $list: list (array) of core special pages
1058
1059 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
1060 $title: title object generated from the text entred by the user
1061
1062 'SpecialSearchResults': called before search result display when there are matches
1063 $term: string of search term
1064 $titleMatches: empty or SearchResultSet object
1065 $textMatches: empty or SearchResultSet object
1066
1067 'SpecialSearchNoResults': called before search result display when there are no matches
1068 $term: string of search term
1069
1070 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1071 $extTypes: associative array of extensions types
1072
1073 'TitleMoveComplete': after moving an article (title)
1074 $old: old title
1075 $nt: new title
1076 $user: user who did the move
1077 $pageid: database ID of the page that's been moved
1078 $redirid: database ID of the created redirect
1079
1080 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1081 $title: title object related to the revision
1082 $rev: revision (object) that will be viewed
1083
1084 'UnknownAction': An unknown "action" has occured (useful for defining
1085 your own actions)
1086 $action: action name
1087 $article: article "acted on"
1088
1089 'UnwatchArticle': before a watch is removed from an article
1090 $user: user watching
1091 $article: article object to be removed
1092
1093 'UnwatchArticle': after a watch is removed from an article
1094 $user: user that was watching
1095 $article: article object removed
1096
1097 'UnwatchArticleComplete': after a watch is removed from an article
1098 $user: user that watched
1099 $article: article object that was watched
1100
1101 'UploadForm:initial': before the upload form is generated
1102 $form: UploadForm object
1103 You might set the member-variables $uploadFormTextTop and
1104 $uploadFormTextAfterSummary to inject text (HTML) either before
1105 or after the editform.
1106
1107 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1108 $form: UploadForm object
1109 Lets you poke at member variables like $mUploadDescription before the
1110 file is saved.
1111
1112 'UploadVerification': additional chances to reject an uploaded file
1113 string $saveName: destination file name
1114 string $tempName: filesystem path to the temporary file for checks
1115 string &$error: output: HTML error to show if upload canceled by returning false
1116
1117 'UploadComplete': Upon completion of a file upload
1118 $uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
1119
1120 'UserArrayFromResult': called when creating an UserArray object from a database result
1121 &$userArray: set this to an object to override the default object returned
1122 $res: database result used to create the object
1123
1124 'userCan': To interrupt/advise the "user can do X to Y article" check.
1125 If you want to display an error message, try getUserPermissionsErrors.
1126 $title: Title object being checked against
1127 $user : Current user object
1128 $action: Action being checked
1129 $result: Pointer to result returned if hook returns false. If null is returned,
1130 userCan checks are continued by internal code.
1131
1132 'UserCanSendEmail': To override User::canSendEmail() permission check
1133 $user: User (object) whose permission is being checked
1134 &$canSend: bool set on input, can override on output
1135
1136
1137 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1138 $user: User (object) that'll clear the message
1139
1140 'UserCreateForm': change to manipulate the login form
1141 $template: SimpleTemplate instance for the form
1142
1143 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1144 $user: User to get groups for
1145 &$groups: Current effective groups
1146
1147 'UserGetAllRights': after calculating a list of all available rights
1148 &$rights: Array of rights, which may be added to.
1149
1150 'UserGetEmail': called when getting an user email address
1151 $user: User object
1152 &$email: email, change this to override local email
1153
1154 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of email authentification
1155 $user: User object
1156 &$timestamp: timestamp, change this to override local email authentification timestamp
1157
1158 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1159 &$groups: List of implicit (automatically-assigned) groups
1160
1161 'UserGetRights': Called in User::getRights()
1162 $user: User to get rights for
1163 &$rights: Current rights
1164
1165 'UserLoadFromSession': called to authenticate users on external/environmental means
1166 $user: user object being loaded
1167 &$result: set this to a boolean value to abort the normal authentification process
1168
1169 'UserLoginComplete': after a user has logged in
1170 $user: the user object that was created on login
1171 $inject_html: Any HTML to inject after the "logged in" message.
1172
1173 'UserLoginForm': change to manipulate the login form
1174 $template: SimpleTemplate instance for the form
1175
1176 'UserLogout': before a user logs out
1177 $user: the user object that is about to be logged out
1178
1179 'UserLogoutComplete': after a user has logged out
1180 $user: the user object _after_ logout (won't have name, ID, etc.)
1181 $inject_html: Any HTML to inject after the "logged out" message.
1182
1183 'UserRights': After a user's group memberships are changed
1184 $user : User object that was changed
1185 $add : Array of strings corresponding to groups added
1186 $remove: Array of strings corresponding to groups removed
1187
1188 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1189 $user: user retrieving new talks messages
1190 $talks: array of new talks page(s)
1191
1192 'UserSaveSettings': called when saving user settings
1193 $user: User object
1194
1195 'UserSetEmail': called when changing user email address
1196 $user: User object
1197 &$email: new email, change this to override new email address
1198
1199 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp of email authentification
1200 $user: User object
1201 &$timestamp: new timestamp, change this to override local email authentification timestamp
1202
1203 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1204 $toggles: array of toggles to add
1205
1206 'WatchArticle': before a watch is added to an article
1207 $user: user that will watch
1208 $article: article object to be watched
1209
1210 'WatchArticleComplete': after a watch is added to an article
1211 $user: user that watched
1212 $article: article object watched
1213
1214 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1215 $query: $wgQueryPages itself
1216
1217 More hooks might be available but undocumented, you can execute
1218 ./maintenance/findhooks.php to find hidden one.