* Adding/updating Persian translations
[mediawiki.git] / docs / hooks.txt
blob4fe5326affc6453116e545d29633f57545ee1dc2
1 hooks.txt
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.
6 ==Glossary==
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'.
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==
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.
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):
38         function showAnArticle($article) {
39                 global $wgReverseTitle, $wgCapitalizeTitle;
41                 if ($wgReverseTitle) {
42                         wfReverseTitle($article);
43                 }
45                 if ($wgCapitalizeTitle) {
46                         wfCapitalizeTitle($article);
47                 }
49                 # code to actually show the article goes here
50         }
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:
56     function showAnArticle($article) {
57         global $wgReverseTitle, $wgCapitalizeTitle;
58         
59         if ($wgReverseTitle) {
60             wfReverseTitle($article);
61         }
62         
63         if ($wgCapitalizeTitle) {
64            wfCapitalizeTitle($article);
65         }
67         # code to actually show the article goes here
68         
69         if ($wgNotifyArticle) {
70            wfNotifyArticleShow($article));
71         }
72     }
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:
78         function showAnArticle($article) {
80                 if (wfRunHooks('ArticleShow', array(&$article))) {
82                         # code to actually show the article goes here
84                         wfRunHooks('ArticleShowComplete', array(&$article));
85                 }
86         }
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.
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:
99         function reverseArticleTitle($article) {
100                 # ...
101         }
103         function reverseForExport($article) {
104                 # ...
105         }
107 The setup function for the extension just has to add its hook
108 functions to the appropriate events:
110         setupTitleReversingExtension() {
111                 global $wgHooks;
113                 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
114                 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
115                 $wgHooks['ArticleExport'][] = 'reverseForExport';
116         }
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.
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:
127         require_once('extensions/ReverseTitle.php');
129 ...to their LocalSettings.php file; those of us who don't want or need
130 it can just leave it out.
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.
136 ==Writing hooks==
138 A hook is a chunk of code run at some particular event. It consists of:
140   * a function with some optional accompanying data, or
141   * an object with a method and some optional accompanying data.
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:
146         $wgHooks['EventName'][] = 'someFunction'; # function, no data
147         $wgHooks['EventName'][] = array('someFunction', $someData);
148         $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
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
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:
160         # function, no data
161         someFunction($param1, $param2)
162         # function with data
163         someFunction($someData, $param1, $param2)
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.
176 The extra data is useful if we want to use the same function or object
177 for different purposes. For example:
179         $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
180         $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
182 This code would result in ircNotify being run twice when an article is
183 saved: once for 'TimStarling', and once for 'brion'.
185 Hooks can return three possible values:
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:
198         $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
199   
200         function ldapLogin($username, $password) {
201                 # log user into LDAP
202                 return false;
203         }
205 Returning false makes less sense for events where the action is
206 complete, and will normally be ignored.
208 ==Using hooks==
210 A calling function or method uses the wfRunHooks() function to run
211 the hooks related to a particular event, like so:
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.
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.
236 ==Events and parameters==
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.
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.
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
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
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)
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; ).
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
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
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
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
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
293 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
294 $article: article (object) of the user talk page
296 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
297 $article: article (object) being modified
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
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
314 'ArticleMergeComplete': after merging to article using Special:Mergehistory
315 $targetTitle: target title (object)
316 $destTitle: destination title (object) 
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
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
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
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
340 'ArticlePurge': before executing "&action=purge" 
341 $article: article (object) to purge
343 'ArticleRevisionUndeleted' after an article revision is restored
344 $title: the article title
345 $revision: the revision
346 $oldPageID: the page ID of the revision when archived (may be null)
348 'ArticleRollbackComplete': after an article rollback is completed
349 $article: the article that was edited
350 $user: the user who did the rollback
351 $revision: the revision the page was reverted back to
353 'ArticleSave': before an article is saved
354 $article: the article (object) being saved
355 $user: the user (object) saving the article
356 $text: the new article text
357 $summary: the article summary (comment)
358 $isminor: minor flag
359 $iswatch: watch flag
360 $section: section #
362 'ArticleSaveComplete': After an article has been updated
363 $article: Article modified
364 $user: User performing the modification
365 $text: New content
366 $summary: Edit summary/comment
367 $isMinor: Whether or not the edit was marked as minor
368 $isWatch: (No longer used)
369 $section: (No longer used)
370 $flags: Flags passed to Article::doEdit()
371 $revision: New Revision of the article
373 'ArticleSaveComplete': after an article is saved
374 $article: the article (object) saved
375 $user: the user (object) who saved the article
376 $text: the new article text
377 $summary: the article summary (comment)
378 $isminor: minor flag
379 $iswatch: watch flag
380 $section: section #
382 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
384 'ArticleUndelete': When one or more revisions of an article are restored
385 $title: Title corresponding to the article restored
386 $create: Whether or not the restoration caused the page to be created
387 (i.e. it didn't exist before)
389 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
390 &$article: the article
391 &$sectionanchor: The section anchor link (e.g. "#overview" )
392 &$extraq: Extra query parameters which can be added via hooked functions
394 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
395 &$article: the article
396 &$pcache: whether to try the parser cache or not
397 &$outputDone: whether the output for this page finished or not
399 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
400 $article: target article (object)
402 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
403 Gives a chance for an extension to set it programattically to a variable class.
404 &$auth: the $wgAuth object, probably a stub
406 'AutoAuthenticate': called to authenticate users on external/environmental means
407 $user: writes user object to this parameter
409 'AutopromoteCondition': check autopromote condition for user.
410 $type: condition type
411 $args: arguments
412 $user: user
413 $result: result of checking autopromote condition
415 'BadImage': When checking against the bad image list
416 $name: Image name being checked
417 &$bad: Whether or not the image is "bad"
419 Change $bad and return false to override. If an image is "bad", it is not
420 rendered inline in wiki pages or galleries in category pages.
422 'BeforeGalleryFindFile': before an image is fetched for a gallery
423 &$gallery,: the gallery object
424 &$nt: the image title 
425 &$time: image timestamp
427 'BeforePageDisplay': Prior to outputting a page
428 $out: OutputPage object
430 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
431 &$parser: Parser object
432 &$title: title of the template
433 &$skip: skip this template and link it?
434 &$id: the id of the revision being parsed
436 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
437 &$parser: Parser object
438 &$nt: the image title
439 &$skip: skip this image and link it?
440 &$time: the image timestamp
442 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
443 &$parser: Parser object
444 &$ig: ImageGallery object
446 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
447 $nondefaults: Assoc array with the following keys:
448               days, hideOwn, hideBots, hideMinor, namespace
449 $wgUser: wgUser.
450 &$hookSql: a string which will be inserted without sanitation into the SQL query
451            used to get the watchlist, at the end of the WHERE part.
453 'BlockIp': before an IP address or user is blocked
454 $block: the Block object about to be saved
455 $user: the user _doing_ the block (not the one being blocked)
457 'BlockIpComplete': after an IP address or user is blocked
458 $block: the Block object that was saved
459 $user: the user who did the block (not the one being blocked)
461 'BookInformation': Before information output on Special:Booksources
462 $isbn: ISBN to show information for
463 $output: OutputPage object in use
465 'BrokenLink': Before the HTML is created for a broken (i.e. red) link
466 &$this: Linker instance
467 $nt: the page title
468 $query: the URL query string passed in
469 &$u: the URL of this link
470 &$style: the inline CSS style
471 &$prefix: a prefix prepended to the linked text
472 &$text: the text placed by the user in the wiki-link
473 &$inside: any additional alphanumeric characters placed after the wiki-link,
474 that are made part of the link text
475 &$trail: text placed immediately after the HTML link
477 'CategoryPageView': before viewing a categorypage in CategoryPage::view
478 $catpage: CategoryPage instance
480 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
481 &$this:        ChangesList instance.
482 &$articlelink: HTML of link to article (already filled-in).
483 &$s:           HTML of row that is being constructed.
484 &$rc:          RecentChange instance.
485 $unpatrolled:  Whether or not we are showing unpatrolled changes.
486 $watched:      Whether or not the change is watched by the user.
488 'ContributionsToolLinks': Change tool links above Special:Contributions
489 $id: User identifier
490 $title: User page title
491 &$tools: Array of tool links
493 'CustomEditor': When invoking the page editor
494 $article: Article being edited
495 $user: User performing the edit
497 Return true to allow the normal editor to be used, or false
498 if implementing a custom editor, e.g. for a special namespace,
499 etc.
501 'DiffViewHeader': called before diff display
502 $diff: DifferenceEngine object that's calling
503 $oldRev: Revision object of the "old" revision (may be null/invalid)
504 $newRev: Revision object of the "new" revision
506 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
507 $article: article (object) being viewed
508 $oldid: oldid (int) being viewed
510 'EditFilter': Perform checks on an edit
511 $editor: Edit form (see includes/EditPage.php)
512 $text: Contents of the edit box
513 $section: Section being edited
514 &$error: Error message to return
516 'EditFilterMerged': Post-section-merge edit filter
517 $editor: EditPage instance (object)
518 $text: content of the edit box
519 $error: error message to return
521 'EditFormPreloadText': Allows population of the edit form when creating new pages
522 &$text: Text to preload with
523 &$title: Title object representing the page being created
525 'EditPage::attemptSave': called before an article is
526 saved, that is before insertNewArticle() is called
527 &$editpage_Obj: the current EditPage object
529 'EditPage::showEditForm:fields': allows injection of form field into edit form
530 &$editor: the EditPage instance for reference
531 &$out: an OutputPage instance to write to
532 return value is ignored (should always return true)
534 'EditPage::showEditForm:initial': before showing the edit form
535 $editor: EditPage instance (object)
537 Return false to halt editing; you'll need to handle error messages, etc. yourself.
538 Alternatively, modifying $error and returning true will cause the contents of $error
539 to be echoed at the top of the edit form as wikitext. Return true without altering
540 $error to allow the edit to proceed.
542 'EditPageBeforeEditButtons':  allows modifying the edit buttons below the textarea in the edit form
543 &$editpage: The current EditPage object
544 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
546 'EditSectionLink': Override the return value of Linker::editSectionLink()
547 $skin: Skin rendering the UI
548 $title: Title being linked to
549 $section: Section to link to
550 $link: Default link
551 $result: Result (alter this to override the generated links)
553 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
554 $skin: Skin rendering the UI
555 $title: Title being linked to
556 $section: Section to link to
557 $hint: Anchor title/tooltip attributes
558 $link: Default link
559 $result: Result (alter this to override the generated links)
561 'EmailConfirmed': When checking that the user's email address is "confirmed"
562 $user: User being checked
563 $confirmed: Whether or not the email address is confirmed
564 This runs before the other checks, such as anonymity and the real check; return
565 true to allow those checks to occur, and false if checking is done.
567 'EmailUser': before sending email from one user to another
568 $to: address of receiving user
569 $from: address of sending user
570 $subject: subject of the mail
571 $text: text of the mail
573 'EmailUserComplete': after sending email from one user to another
574 $to: address of receiving user
575 $from: address of sending user
576 $subject: subject of the mail
577 $text: text of the mail
579 'FetchChangesList': When fetching the ChangesList derivative for a particular user
580 &$user: User the list is being fetched for
581 &$skin: Skin object to be used with the list
582 &$list: List object (defaults to NULL, change it to an object instance and return
583 false override the list derivative used)
585 'FileDeleteComplete': When a file is deleted
586 $file: reference to the deleted file
587 $oldimage: in case of the deletion of an old image, the name of the old file
588 $article: in case all revisions of the file are deleted a reference to the article 
589           associated with the file.
590 $user: user who performed the deletion
591 $reason: reason
593 'FileUpload': When a file upload occurs
594 $file : Image object representing the file that was uploaded
596 'FileUndeleteComplete': When a file is undeleted
597 $title: title object to the file
598 $fileVersions: array of undeleted versions. Empty if all versions were restored
599 $user: user who performed the undeletion
600 $reason: reason
602 'GetBlockedStatus': after loading blocking status of an user from the database
603 $user: user (object) being checked
605 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
606 $title: Title object of page
607 $url: string value as output (out parameter, can modify)
608 $query: query options passed to Title::getFullURL()
610 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
611 $title: Title object of page
612 $url: string value as output (out parameter, can modify)
613 $query: query options passed to Title::getInternalURL()
615 'GetLinkColours': modify the CSS class of an array of page links
616 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
617 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
619 'GetLocalURL': modify local URLs as output into page links
620 $title: Title object of page
621 $url: string value as output (out parameter, can modify)
622 $query: query options passed to Title::getLocalURL()
624 'getUserPermissionsErrors': Add a permissions error when permissions errors are
625         checked for.  Use instead of userCan for most cases. Return false if the
626         user can't do it, and populate $result with the reason in the form of
627         array( messagename, param1, param2, ... ).  For consistency, error messages
628         should be plain text with no special coloring, bolding, etc. to show that
629         they're errors; presenting them properly to the user as errors is done by
630         the caller.
631 $title: Title object being checked against
632 $user : Current user object
633 $action: Action being checked
634 $result: User permissions error to add. If none, return true.
636 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
637         if expensive checks are enabled.
639 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
640         the image on an image page
641 $imagePage: ImagePage object ($this)
642 $output: $wgOut
644 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
645         image insertion.  You can skip the default logic entirely by returning
646         false, or just modify a few things using call-by-reference.
647 &$this: Skin object
648 &$title: Title object of the image
649 &$file: File object, or false if it doesn't exist
650 &$frameParams: Various parameters with special meanings; see documentation in
651         includes/Linker.php for Linker::makeImageLink2
652 &$handlerParams: Various parameters with special meanings; see documentation in
653         includes/Linker.php for Linker::makeImageLink2
654 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
655 &$res: Final HTML output, used if you return false
657 'InitPreferencesForm': called at the end of PreferencesForm's constructor
658 $form: the PreferencesForm
659 $request: the web request to initialized from
661 'InternalParseBeforeLinks': during Parser's internalParse method before links but
662 after noinclude/includeonly/onlyinclude and other processing.
663 &$this: Parser object
664 &$text: string containing partially parsed text
665 &$this->mStripState: Parser's internal StripState object
667 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
668 $article: article (object) being checked
670 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
671 $ip: IP being check
672 $result: Change this value to override the result of wfIsTrustedProxy()
674 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
675 tance to return false if the domain name doesn't match your organization
676 $addr: The e-mail address entered by the user
677 &$result: Set this and return false to override the internal checks
679 'isValidPassword': Override the result of User::isValidPassword()
680 $password: The password entered by the user
681 &$result: Set this and return false to override the internal checks
682 $user: User the password is being validated for
684 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
685 $magicExtensions: associative array of magic words synonyms
686 $lang: laguage code (string)
688 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
689 $specialPageAliases: associative array of magic words synonyms
690 $lang: laguage code (string)
692 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
693 &$linksUpdate: the LinkUpdate object
695 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
696 &$linksUpdate: the LinkUpdate object
698 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
699 &$linksUpdate: the LinkUpdate object
701 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
703 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
705 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
706                           No return data is accepted; this hook is for auditing only.
707 $user: the User object being authenticated against
708 $password: the password being submitted and found wanting
709 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
711 'LogLine': Processes a single log entry on Special:Log
712 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type 
713     database field.
714 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
715     to logging.log_action database field.
716 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
717 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
718     appears to contain anything.
719 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
720 &$revert: string that is displayed in the UI, similar to $comment.
721 $time: timestamp of the log entry (added in 1.12) 
723 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
724 &$type: array of strings
726 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
727 &$typeText: array of strings
729 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
730 &$headerText: array of strings
732 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
733 &$actionText: array of strings
735 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
736 $magicWords: array of strings
738 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
739 $variableIDs: array of strings
741 'MarkPatrolled': before an edit is marked patrolled
742 $rcid: ID of the revision to be marked patrolled
743 $user: the user (object) marking the revision as patrolled
744 $wcOnlySysopsCanPatrol: config setting indicating whether the user
745  needs to be a sysop in order to mark an edit patrolled
747 'MarkPatrolledComplete': after an edit is marked patrolled
748 $rcid: ID of the revision marked as patrolled
749 $user: user (object) who marked the edit patrolled
750 $wcOnlySysopsCanPatrol: config setting indicating whether the user
751  must be a sysop to patrol the edit
753 'MathAfterTexvc': after texvc is executed when rendering mathematics
754 $mathRenderer: instance of MathRenderer
755 $errmsg: error message, in HTML (string). Nonempty indicates failure
756  of rendering the formula
758 'MediaWikiPerformAction': Override MediaWiki::performAction().
759 Use this to do something completely different, after the basic
760 globals have been set up, but before ordinary actions take place.
761 $output:  $wgOut
762 $article: $wgArticle
763 $title:   $wgTitle
764 $user:    $wgUser
765 $request: $wgRequest
767 'MessagesPreLoad': When loading a message from the database
768 $title: title of the message (string)
769 $message: value (string), change it to the message you want to define
771 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
772 $tools: array of tools
774 'OutputPageBeforeHTML': a page has been processed by the parser and
775 the resulting HTML is about to be displayed.  
776 $parserOutput: the parserOutput (object) that corresponds to the page 
777 $text: the text that will be displayed, in HTML (string)
779 'OutputPageParserOutput': after adding a parserOutput to $wgOut
780 $out: OutputPage instance (object)
781 $parserOutput: parserOutput instance being added in $out
783 'PageHistoryBeforeList': When a history page list is about to be constructed.
784 $article: the article that the history is loading for
786 'PageHistoryLineEnding' : right before the end <li> is added to a history line
787 $row: the revision row for this line
788 $s: the string representing this parsed line
790 'PageRenderingHash': alter the parser cache option hash key
791   A parser extension which depends on user options should install
792   this hook and append its values to the key.
793 $hash: reference to a hash key string which can be modified
795 'ParserAfterStrip': Same as ParserBeforeStrip
797 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
798 $parser: Parser object being used 
799 $text: text that'll be returned
801 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
802 $parser: Parser object
803 $text: text to parse
804 $stripState: StripState instance being used
806 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
807 $parser: parser object
808 $text: text being parsed
809 $stripState: stripState used (object)
811 'ParserBeforeTidy': called before tidy and custom tags replacements
812 $parser: Parser object being used 
813 $text: actual text
815 'ParserClearState': called at the end of Parser::clearState()
816 $parser: Parser object being cleared
818 'ParserFirstCallInit': called when the parser initialises for the first time
819 &$parser: Parser object being cleared
821 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
822 $parser: Parser object
823 $varCache: array to store the value in case of multiples calls of the same magic word
824 $index: index (string) of the magic
825 $ret: value of the magic word (the hook should set it)
827 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
828 $parser: Parser object
829 $time: actual time (timestamp)
831 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
832 $parser: Parser object
833 $varCache: varaiable cache (array)
835 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
836 $parser: Parser object
837 $limitReport: text that will be included (without comment tags)
839 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
840 $title: title object representing the file
841 $file: file object that will be used to create the image
842 &$params: 2-D array of parameters
844 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
845 $parser: Parser object created
847 'ParserTestTables': alter the list of tables to duplicate when parser tests
848 are run. Use when page save hooks require the presence of custom tables
849 to ensure that tests continue to run properly.
850 &$tables: array of table names
852 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
853 my talk page, my contributions" etc).
855 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
856 &$title: Title object representing the current page
858 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
859 &$user : User performing the action
860 $action : Action being performed
861 &$result : Whether or not the action should be prevented
862 Change $result and return false to give a definitive answer, otherwise
863 the built-in rate limiting checks are used, if enabled.
865 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
866 $form : PreferencesForm object
867 &$html : HTML to append to
869 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
870 AJAX search suggestions. Put results into &$results outparam and return false.
871 $ns : int namespace key to search in
872 $search : search term (not guaranteed to be conveniently normalized)
873 $limit : maximum number of results to return
874 &$results : out param: array of page names (strings)
876 'PrefsEmailAudit': called when user changes his email address
877 $user: User (object) changing his email address
878 $oldaddr: old email address (string)
879 $newaddr: new email address (string)
881 'PrefsPasswordAudit': called when user changes his password
882 $user: User (object) changing his passoword
883 $newPass: new password
884 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
886 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
887 &$obj: RawPage object
888 &$text: The text that's going to be the output
890 'RecentChange_save': called at the end of RecenChange::save()
891 $recentChange: RecentChange object
893 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
894 $form: the PreferencesForm
895 $out: output page to render to, probably $wgOut
897 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
898 $form: the PreferencesForm
899 $user: the User object to load preferences from
901 'SavePreferences': called at the end of PreferencesForm::savePreferences; 
902                    returning false prevents the preferences from being saved.
903 $form: the PreferencesForm
904 $user: the User object to save preferences to
905 $message: change this to set an error message (ignored if the hook does notreturn fals)
907 'SearchUpdate': Prior to search update completion
908 $id : Page id
909 $namespace : Page namespace
910 $title : Page title
911 $text : Current text being indexed
913 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
914 $term : Search term string
915 &$title : Outparam; set to $title object and return false for a match
917 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
918 $text: Text being shown
919 $title: Title of the custom script/stylesheet page
920 $output: Current OutputPage object
922 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
923 &$siteNotice: HTML returned as the sitenotice
924 Return true to allow the normal method of notice selection/rendering to work,
925 or change the value of $siteNotice and return false to alter it.
927 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
928 &$siteNotice: HTML sitenotice
929 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
931 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
932 $skin: Skin object
933 &$text: bottomScripts Text
934 Append to $text to add additional text/scripts after the stock bottom scripts.
936 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
937 $skin: Skin object
938 &$subpages: Subpage links HTML
939 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
940 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
942 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab  when showing a special page
943 $sktemplate: SkinTemplate object
944 $content_actions: array of tabs
946 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
947 $sktemplate: SkinTemplate object
948 $nav_urls: array of tabs
950 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
951 &$content_actions: Content actions
952 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
953 for an example]
955 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
956 &$sktemplate: SkinTemplate object
957 &$tpl: Template engine object
959 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
960 $sktemplate: SkinTemplate object
961 $res: set to true to prevent active tabs
963 'SkinTemplateSetupPageCss': use this to provide per-page CSS
964 $out: Css to return
966 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
967        You can either create your own array, or alter the parameters for the normal one.
968 &$this:     The SkinTemplate instance.
969 $title:     Title instance for the page.
970 $message:   Visible label of tab.
971 $selected:  Whether this is a selected tab.
972 $checkEdit: Whether or not the action=edit query should be added if appropriate.
973 &$classes:  Array of CSS classes to apply.
974 &$query:    Query string to add to link.
975 &$text:     Link text.
976 &$result:   Complete assoc. array if you want to return true.
978 'SkinTemplateTabs': called when finished to build the actions tabs
979 $sktemplate: SkinTemplate object
980 $content_actions: array of tabs
982 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
983 $id: User identifier
985 'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
986 $pager: The UsersPager instance
987 $query: The query array to be returned
989 'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
990 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
991 $row: Database row object
993 'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
994 $pager: The UsersPager instance
995 $out: The header HTML
997 'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
998 $pager: The UsersPager instance
999 $out: The header HTML
1001 'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
1002 $pager: The UsersPager instance
1003 $query: The query array to be returned
1005 'SpecialMovepageAfterMove': called after moving a page
1006 $movePage: MovePageForm object
1007 $oldTitle: old title (object)
1008 $newTitle: new title (object)
1010 'SpecialPageExecuteAfterPage': called after executing a special page
1011 Warning: Not all the special pages call this hook
1012 $specialPage: SpecialPage object
1013 $par: paramter passed to the special page (string)
1014 $funct: function called to execute the special page
1016 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
1017 Warning: Not all the special pages call this hook
1018 $specialPage: SpecialPage object
1019 $par: paramter passed to the special page (string)
1020 $funct: function called to execute the special page
1022 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
1023 Warning: Not all the special pages call this hook
1024 $specialPage: SpecialPage object
1025 $par: paramter passed to the special page (string)
1026 $funct: function called to execute the special page
1028 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
1029 $list: list (array) of core special pages
1031 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
1032 $title: title object generated from the text entred by the user
1034 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1035 $extTypes: associative array of extensions types
1037 'TitleMoveComplete': after moving an article (title)
1038 $old: old title
1039 $nt: new title
1040 $user: user who did the move
1041 $pageid: database ID of the page that's been moved
1042 $redirid: database ID of the created redirect
1044 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1045 $title: title object related to the revision
1046 $rev: revision (object) that will be viewed
1048 'UnknownAction': An unknown "action" has occured (useful for defining
1049                  your own actions)
1050 $action: action name
1051 $article: article "acted on"
1053 'UnwatchArticle': before a watch is removed from an article
1054 $user: user watching
1055 $article: article object to be removed
1057 'UnwatchArticle': after a watch is removed from an article
1058 $user: user that was watching
1059 $article: article object removed
1061 'UnwatchArticleComplete': after a watch is removed from an article
1062 $user: user that watched
1063 $article: article object that was watched
1065 'UploadForm:initial': before the upload form is generated
1066 $form: UploadForm object
1067 You might set the member-variables $uploadFormTextTop and 
1068 $uploadFormTextAfterSummary to inject text (HTML) either before
1069 or after the editform.
1071 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1072 $form: UploadForm object
1073 Lets you poke at member variables like $mUploadDescription before the
1074 file is saved.
1076 'UploadVerification': additional chances to reject an uploaded file
1077 string $saveName: destination file name
1078 string $tempName: filesystem path to the temporary file for checks
1079 string &$error: output: HTML error to show if upload canceled by returning false
1081 'UploadComplete': Upon completion of a file upload
1082 $uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
1084 'userCan': To interrupt/advise the "user can do X to Y article" check.
1085         If you want to display an error message, try getUserPermissionsErrors.
1086 $title: Title object being checked against
1087 $user : Current user object
1088 $action: Action being checked
1089 $result: Pointer to result returned if hook returns false. If null is returned,
1090  userCan checks are continued by internal code.
1092 'UserCanSendEmail': To override User::canSendEmail() permission check
1093 $user: User (object) whose permission is being checked
1094 &$canSend: bool set on input, can override on output
1097 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1098 $user: User (object) that'll clear the message
1100 'UserCreateForm': change to manipulate the login form
1101 $template: SimpleTemplate instance for the form
1103 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1104 $user: User to get groups for
1105 &$groups: Current effective groups
1107 'UserLoginComplete': after a user has logged in
1108 $user: the user object that was created on login
1109                     
1110 'UserLoginForm': change to manipulate the login form
1111 $template: SimpleTemplate instance for the form
1113 'UserLogout': before a user logs out
1114 $user: the user object that is about to be logged out
1115        
1116 'UserLogoutComplete': after a user has logged out
1117 $user: the user object _after_ logout (won't have name, ID, etc.)
1119 'UserRights': After a user's group memberships are changed
1120 $user  : User object that was changed
1121 $add   : Array of strings corresponding to groups added
1122 $remove: Array of strings corresponding to groups removed
1123                       
1124 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1125 &$groups: List of implicit (automatically-assigned) groups
1127 'UserGetRights': Called in User::getRights()
1128 $user: User to get rights for
1129 &$rights: Current rights
1131 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1132 $user: user retrieving new talks messages
1133 $talks: array of new talks page(s)
1135 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1136 $toggles: array of toggles to add
1138 'WatchArticle': before a watch is added to an article
1139 $user: user that will watch
1140 $article: article object to be watched
1142 'WatchArticleComplete': after a watch is added to an article
1143 $user: user that watched
1144 $article: article object watched
1146 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1147 $query: $wgQueryPages itself
1149 More hooks might be available but undocumented, you can execute
1150 ./maintenance/findhooks.php to find hidden one.