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.
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'.
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
22 The function part of a hook.
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);
45 if ($wgCapitalizeTitle) {
46 wfCapitalizeTitle($article);
49 # code to actually show the article goes here
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;
59 if ($wgReverseTitle) {
60 wfReverseTitle($article);
63 if ($wgCapitalizeTitle) {
64 wfCapitalizeTitle($article);
67 # code to actually show the article goes here
69 if ($wgNotifyArticle) {
70 wfNotifyArticleShow($article));
74 Using a hook-running strategy, we can avoid having all this
75 option-specific stuff in our mainline code. Using hooks, the function
78 function showAnArticle($article) {
80 if (wfRunHooks('ArticleShow', array(&$article))) {
82 # code to actually show the article goes here
84 wfRunHooks('ArticleShowComplete', array(&$article));
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) {
103 function reverseForExport($article) {
107 The setup function for the extension just has to add its hook
108 functions to the appropriate events:
110 setupTitleReversingExtension() {
113 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
114 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
115 $wgHooks['ArticleExport'][] = 'reverseForExport';
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
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
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:
161 someFunction($param1, $param2)
163 someFunction($someData, $param1, $param2)
166 $object->onEventName($param1, $param2)
168 $object->someMethod($param1, $param2)
169 # object with method and data
170 $object->someMethod($someData, $param1, $param2)
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
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
198 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
200 function ldapLogin($username, $password) {
205 Returning false makes less sense for events where the action is
206 complete, and will normally be ignored.
210 A calling function or method uses the wfRunHooks() function to run
211 the hooks related to a particular event, like so:
217 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
218 # protect the article
219 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
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 'AbortAutoblock': Return false to cancel an autoblock.
242 $autoblockip: The IP going to be autoblocked.
243 $block: The block from which the autoblock is coming.
245 'AbortLogin': Return false to cancel account login.
246 $user: the User object being authenticated against
247 $password: the password being submitted, not yet checked for validity
248 &$retval: a LoginForm class constant to return from authenticateUserData();
249 default is LoginForm::ABORTED. Note that the client may be using
250 a machine API rather than the HTML user interface.
252 'AbortMove': allows to abort moving an article (title)
255 $user: user who is doing the move
258 'AbortNewAccount': Return false to cancel account creation.
259 $user: the User object about to be created (read-only, incomplete)
260 $message: out parameter: error message to display on abort
262 'AddNewAccount': after a user account is created
263 $user: the User object that was created. (Parameter added in 1.7)
264 $byEmail: true when account was created "by email" (added in 1.12)
266 'AjaxAddScript': Called in output page just before the initialisation
267 of the javascript ajax engine. The hook is only called when ajax
268 is enabled ( $wgUseAjax = true; ).
270 'AlternateEdit': before checking if an user can edit a page and
271 before showing the edit form ( EditPage::edit() ). This is triggered
273 $EditPage : the EditPage object
275 'APIEditBeforeSave': before saving a page with api.php?action=edit,
276 after processing request parameters. Return false to let the request
277 fail, returning an error message or an <edit result="Failure"> tag
278 if $resultArr was filled.
279 $EditPage : the EditPage object
280 $text : the new text of the article (has yet to be saved)
281 $resultArr : data in this array will be added to the API result
283 'ArticleAfterFetchContent': after fetching content of an article from the database
284 $article: the article (object) being loaded from the database
285 $content: the content (string) of the article
287 'ArticleDelete': before an article is deleted
288 $article: the article (object) being deleted
289 $user: the user (object) deleting the article
290 $reason: the reason (string) the article is being deleted
292 'ArticleDeleteComplete': after an article is deleted
293 $article: the article that was deleted
294 $user: the user that deleted the article
295 $reason: the reason the article was deleted
296 $id: id of the article that was deleted
298 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
299 $article: article (object) of the user talk page
301 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
302 $article: article (object) being modified
304 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
305 $title: title (object) used to create the article object
306 $article: article (object) that will be returned
308 'ArticleInsertComplete': After an article is created
309 $article: Article created
310 $user: User creating the article
312 $summary: Edit summary/comment
313 $isMinor: Whether or not the edit was marked as minor
314 $isWatch: (No longer used)
315 $section: (No longer used)
316 $flags: Flags passed to Article::doEdit()
317 $revision: New Revision of the article
319 'ArticleMergeComplete': after merging to article using Special:Mergehistory
320 $targetTitle: target title (object)
321 $destTitle: destination title (object)
323 'ArticlePageDataAfter': after loading data of an article from the database
324 $article: article (object) whose data were loaded
325 $row: row (object) returned from the database server
327 'ArticlePageDataBefore': before loading data of an article from the database
328 $article: article (object) that data will be loaded
329 $fields: fileds (array) to load from the database
331 'ArticleProtect': before an article is protected
332 $article: the article being protected
333 $user: the user doing the protection
334 $protect: boolean whether this is a protect or an unprotect
335 $reason: Reason for protect
336 $moveonly: boolean whether this is for move only or not
338 'ArticleProtectComplete': after an article is protected
339 $article: the article that was protected
340 $user: the user who did the protection
341 $protect: boolean whether it was a protect or an unprotect
342 $reason: Reason for protect
343 $moveonly: boolean whether it was for move only or not
345 'ArticlePurge': before executing "&action=purge"
346 $article: article (object) to purge
348 'ArticleRevisionVisiblitySet': called when changing visibility of one or more
349 revision of an article
350 &$title: title object of the article
352 'ArticleRevisionUndeleted': after an article revision is restored
353 $title: the article title
354 $revision: the revision
355 $oldPageID: the page ID of the revision when archived (may be null)
357 'ArticleRollbackComplete': after an article rollback is completed
358 $article: the article that was edited
359 $user: the user who did the rollback
360 $revision: the revision the page was reverted back to
362 'ArticleSave': before an article is saved
363 $article: the article (object) being saved
364 $user: the user (object) saving the article
365 $text: the new article text
366 $summary: the article summary (comment)
371 'ArticleSaveComplete': After an article has been updated
372 $article: Article modified
373 $user: User performing the modification
375 $summary: Edit summary/comment
376 $isMinor: Whether or not the edit was marked as minor
377 $isWatch: (No longer used)
378 $section: (No longer used)
379 $flags: Flags passed to Article::doEdit()
380 $revision: New Revision of the article
382 'ArticleSaveComplete': after an article is saved
383 $article: the article (object) saved
384 $user: the user (object) who saved the article
385 $text: the new article text
386 $summary: the article summary (comment)
391 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
393 'ArticleUndelete': When one or more revisions of an article are restored
394 $title: Title corresponding to the article restored
395 $create: Whether or not the restoration caused the page to be created
396 (i.e. it didn't exist before)
398 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
399 &$article: the article
400 &$sectionanchor: The section anchor link (e.g. "#overview" )
401 &$extraq: Extra query parameters which can be added via hooked functions
403 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
404 &$article: the article
405 &$pcache: whether to try the parser cache or not
406 &$outputDone: whether the output for this page finished or not
408 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
409 $article: target article (object)
411 'AuthPluginAutoCreate': Called when creating a local account for an user logged
412 in from an external authentication method
413 $user: User object created locally
415 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
416 Gives a chance for an extension to set it programattically to a variable class.
417 &$auth: the $wgAuth object, probably a stub
419 'AutopromoteCondition': check autopromote condition for user.
420 $type: condition type
423 $result: result of checking autopromote condition
425 'BadImage': When checking against the bad image list
426 $name: Image name being checked
427 &$bad: Whether or not the image is "bad"
429 Change $bad and return false to override. If an image is "bad", it is not
430 rendered inline in wiki pages or galleries in category pages.
432 'BeforeGalleryFindFile': before an image is fetched for a gallery
433 &$gallery,: the gallery object
434 &$nt: the image title
435 &$time: image timestamp
437 'BeforePageDisplay': Prior to outputting a page
438 &$out: OutputPage object
441 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
442 &$parser: Parser object
443 &$title: title of the template
444 &$skip: skip this template and link it?
445 &$id: the id of the revision being parsed
447 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
448 &$parser: Parser object
449 &$nt: the image title
450 &$skip: skip this image and link it?
451 &$time: the image timestamp
453 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
454 &$parser: Parser object
455 &$ig: ImageGallery object
457 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
458 $nondefaults: Assoc array with the following keys:
459 days, hideOwn, hideBots, hideMinor, namespace
461 &$hookSql: a string which will be inserted without sanitation into the SQL query
462 used to get the watchlist, at the end of the WHERE part.
464 'BlockIp': before an IP address or user is blocked
465 $block: the Block object about to be saved
466 $user: the user _doing_ the block (not the one being blocked)
468 'BlockIpComplete': after an IP address or user is blocked
469 $block: the Block object that was saved
470 $user: the user who did the block (not the one being blocked)
472 'BookInformation': Before information output on Special:Booksources
473 $isbn: ISBN to show information for
474 $output: OutputPage object in use
476 'BrokenLink': Before the HTML is created for a broken (i.e. red) link
477 &$linker: Linker instance
479 $query: the URL query string passed in
480 &$u: the URL of this link
481 &$style: the inline CSS style
482 &$prefix: a prefix prepended to the linked text
483 &$text: the text placed by the user in the wiki-link
484 &$inside: any additional alphanumeric characters placed after the wiki-link,
485 that are made part of the link text
486 &$trail: text placed immediately after the HTML link
488 'CategoryPageView': before viewing a categorypage in CategoryPage::view
489 $catpage: CategoryPage instance
491 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
492 &$this: ChangesList instance.
493 &$articlelink: HTML of link to article (already filled-in).
494 &$s: HTML of row that is being constructed.
495 &$rc: RecentChange instance.
496 $unpatrolled: Whether or not we are showing unpatrolled changes.
497 $watched: Whether or not the change is watched by the user.
499 'ContributionsToolLinks': Change tool links above Special:Contributions
501 $title: User page title
502 &$tools: Array of tool links
504 'CustomEditor': When invoking the page editor
505 $article: Article being edited
506 $user: User performing the edit
508 Return true to allow the normal editor to be used, or false
509 if implementing a custom editor, e.g. for a special namespace,
512 'DiffViewHeader': called before diff display
513 $diff: DifferenceEngine object that's calling
514 $oldRev: Revision object of the "old" revision (may be null/invalid)
515 $newRev: Revision object of the "new" revision
517 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
518 $article: article (object) being viewed
519 $oldid: oldid (int) being viewed
521 'EditFilter': Perform checks on an edit
522 $editor: Edit form (see includes/EditPage.php)
523 $text: Contents of the edit box
524 $section: Section being edited
525 &$error: Error message to return
527 'EditFilterMerged': Post-section-merge edit filter
528 $editor: EditPage instance (object)
529 $text: content of the edit box
530 $error: error message to return
532 'EditFormPreloadText': Allows population of the edit form when creating new pages
533 &$text: Text to preload with
534 &$title: Title object representing the page being created
536 'EditPage::attemptSave': called before an article is
537 saved, that is before insertNewArticle() is called
538 &$editpage_Obj: the current EditPage object
540 'EditPage::showEditForm:fields': allows injection of form field into edit form
541 &$editor: the EditPage instance for reference
542 &$out: an OutputPage instance to write to
543 return value is ignored (should always return true)
545 'EditPage::showEditForm:initial': before showing the edit form
546 $editor: EditPage instance (object)
548 Return false to halt editing; you'll need to handle error messages, etc. yourself.
549 Alternatively, modifying $error and returning true will cause the contents of $error
550 to be echoed at the top of the edit form as wikitext. Return true without altering
551 $error to allow the edit to proceed.
553 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
554 when there's an edit conflict. Return false to halt normal diff output; in
555 this case you're responsible for computing and outputting the entire "conflict"
556 part, i.e., the "difference between revisions" and "your text" headers and
558 &$editor: EditPage instance
559 &$out: OutputPage instance
561 'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form
562 &$editpage: The current EditPage object
563 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
565 'EditSectionLink': Override the return value of Linker::editSectionLink()
566 $skin: Skin rendering the UI
567 $title: Title being linked to
568 $section: Section to link to
570 $result: Result (alter this to override the generated links)
572 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
573 $skin: Skin rendering the UI
574 $title: Title being linked to
575 $section: Section to link to
576 $hint: Anchor title/tooltip attributes
578 $result: Result (alter this to override the generated links)
580 'EmailConfirmed': When checking that the user's email address is "confirmed"
581 $user: User being checked
582 $confirmed: Whether or not the email address is confirmed
583 This runs before the other checks, such as anonymity and the real check; return
584 true to allow those checks to occur, and false if checking is done.
586 'EmailUser': before sending email from one user to another
587 $to: address of receiving user
588 $from: address of sending user
589 $subject: subject of the mail
590 $text: text of the mail
592 'EmailUserComplete': after sending email from one user to another
593 $to: address of receiving user
594 $from: address of sending user
595 $subject: subject of the mail
596 $text: text of the mail
598 'FetchChangesList': When fetching the ChangesList derivative for a particular user
599 &$user: User the list is being fetched for
600 &$skin: Skin object to be used with the list
601 &$list: List object (defaults to NULL, change it to an object instance and return
602 false override the list derivative used)
604 'FileDeleteComplete': When a file is deleted
605 $file: reference to the deleted file
606 $oldimage: in case of the deletion of an old image, the name of the old file
607 $article: in case all revisions of the file are deleted a reference to the article
608 associated with the file.
609 $user: user who performed the deletion
612 'FileUpload': When a file upload occurs
613 $file : Image object representing the file that was uploaded
615 'FileUndeleteComplete': When a file is undeleted
616 $title: title object to the file
617 $fileVersions: array of undeleted versions. Empty if all versions were restored
618 $user: user who performed the undeletion
621 'GetBlockedStatus': after loading blocking status of an user from the database
622 $user: user (object) being checked
624 'GetCacheVaryCookies': get cookies that should vary cache options
625 $out: OutputPage object
626 &$cookies: array of cookies name, add a value to it if you want to add a cookie
627 that have to vary cache options
629 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
630 $title: Title object of page
631 $url: string value as output (out parameter, can modify)
632 $query: query options passed to Title::getFullURL()
634 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
635 $title: Title object of page
636 $url: string value as output (out parameter, can modify)
637 $query: query options passed to Title::getInternalURL()
639 'GetLinkColours': modify the CSS class of an array of page links
640 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
641 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
643 'GetLocalURL': modify local URLs as output into page links
644 $title: Title object of page
645 $url: string value as output (out parameter, can modify)
646 $query: query options passed to Title::getLocalURL()
648 'getUserPermissionsErrors': Add a permissions error when permissions errors are
649 checked for. Use instead of userCan for most cases. Return false if the
650 user can't do it, and populate $result with the reason in the form of
651 array( messagename, param1, param2, ... ). For consistency, error messages
652 should be plain text with no special coloring, bolding, etc. to show that
653 they're errors; presenting them properly to the user as errors is done by
655 $title: Title object being checked against
656 $user : Current user object
657 $action: Action being checked
658 $result: User permissions error to add. If none, return true.
660 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
661 if expensive checks are enabled.
663 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
664 image insertion. You can skip the default logic entirely by returning
665 false, or just modify a few things using call-by-reference.
667 &$title: Title object of the image
668 &$file: File object, or false if it doesn't exist
669 &$frameParams: Various parameters with special meanings; see documentation in
670 includes/Linker.php for Linker::makeImageLink2
671 &$handlerParams: Various parameters with special meanings; see documentation in
672 includes/Linker.php for Linker::makeImageLink2
673 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
674 &$res: Final HTML output, used if you return false
677 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
678 the image on an image page
679 $imagePage: ImagePage object ($this)
682 'ImagePageFileHistoryLine': called when a file history line is contructed
684 $line: the HTML of the history line
685 $css: the line CSS class
687 'InitPreferencesForm': called at the end of PreferencesForm's constructor
688 $form: the PreferencesForm
689 $request: the web request to initialized from
691 'InternalParseBeforeLinks': during Parser's internalParse method before links but
692 after noinclude/includeonly/onlyinclude and other processing.
693 &$this: Parser object
694 &$text: string containing partially parsed text
695 &$this->mStripState: Parser's internal StripState object
697 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
698 $article: article (object) being checked
700 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
702 $result: Change this value to override the result of wfIsTrustedProxy()
704 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
705 tance to return false if the domain name doesn't match your organization
706 $addr: The e-mail address entered by the user
707 &$result: Set this and return false to override the internal checks
709 'isValidPassword': Override the result of User::isValidPassword()
710 $password: The password entered by the user
711 &$result: Set this and return false to override the internal checks
712 $user: User the password is being validated for
714 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
715 $magicExtensions: associative array of magic words synonyms
716 $lang: laguage code (string)
718 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
719 $specialPageAliases: associative array of magic words synonyms
720 $lang: laguage code (string)
722 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
723 &$linksUpdate: the LinkUpdate object
725 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
726 &$linksUpdate: the LinkUpdate object
728 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
729 &$linksUpdate: the LinkUpdate object
731 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
733 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
735 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
736 No return data is accepted; this hook is for auditing only.
737 $user: the User object being authenticated against
738 $password: the password being submitted and found wanting
739 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
741 'LogLine': Processes a single log entry on Special:Log
742 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
744 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
745 to logging.log_action database field.
746 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
747 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
748 appears to contain anything.
749 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
750 &$revert: string that is displayed in the UI, similar to $comment.
751 $time: timestamp of the log entry (added in 1.12)
753 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
754 &$type: array of strings
756 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
757 &$typeText: array of strings
759 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
760 &$headerText: array of strings
762 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
763 &$actionText: array of strings
765 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
766 $magicWords: array of strings
768 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
769 $variableIDs: array of strings
771 'MarkPatrolled': before an edit is marked patrolled
772 $rcid: ID of the revision to be marked patrolled
773 $user: the user (object) marking the revision as patrolled
774 $wcOnlySysopsCanPatrol: config setting indicating whether the user
775 needs to be a sysop in order to mark an edit patrolled
777 'MarkPatrolledComplete': after an edit is marked patrolled
778 $rcid: ID of the revision marked as patrolled
779 $user: user (object) who marked the edit patrolled
780 $wcOnlySysopsCanPatrol: config setting indicating whether the user
781 must be a sysop to patrol the edit
783 'MathAfterTexvc': after texvc is executed when rendering mathematics
784 $mathRenderer: instance of MathRenderer
785 $errmsg: error message, in HTML (string). Nonempty indicates failure
786 of rendering the formula
788 'MediaWikiPerformAction': Override MediaWiki::performAction().
789 Use this to do something completely different, after the basic
790 globals have been set up, but before ordinary actions take place.
797 'MessagesPreLoad': When loading a message from the database
798 $title: title of the message (string)
799 $message: value (string), change it to the message you want to define
801 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
802 Note: this is only run for the Monobook skin. To add items to the toolbox
803 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
805 $tools: array of tools
807 'NewRevisionFromEditComplete': called when a revision was inserted due to an edit
808 $article: the article edited
809 $rev: the new revision
810 $baseID: the revision ID this was based off, if any
812 'OutputPageBeforeHTML': a page has been processed by the parser and
813 the resulting HTML is about to be displayed.
814 $parserOutput: the parserOutput (object) that corresponds to the page
815 $text: the text that will be displayed, in HTML (string)
817 'OutputPageParserOutput': after adding a parserOutput to $wgOut
818 $out: OutputPage instance (object)
819 $parserOutput: parserOutput instance being added in $out
821 'PageHistoryBeforeList': When a history page list is about to be constructed.
822 $article: the article that the history is loading for
824 'PageHistoryLineEnding' : right before the end <li> is added to a history line
825 $row: the revision row for this line
826 $s: the string representing this parsed line
828 'PageRenderingHash': alter the parser cache option hash key
829 A parser extension which depends on user options should install
830 this hook and append its values to the key.
831 $hash: reference to a hash key string which can be modified
833 'ParserAfterStrip': Same as ParserBeforeStrip
835 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
836 $parser: Parser object being used
837 $text: text that'll be returned
839 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
840 $parser: Parser object
842 $stripState: StripState instance being used
844 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
845 $parser: parser object
846 $text: text being parsed
847 $stripState: stripState used (object)
849 'ParserBeforeTidy': called before tidy and custom tags replacements
850 $parser: Parser object being used
853 'ParserClearState': called at the end of Parser::clearState()
854 $parser: Parser object being cleared
856 'ParserFirstCallInit': called when the parser initialises for the first time
857 &$parser: Parser object being cleared
859 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
860 $parser: Parser object
861 $varCache: array to store the value in case of multiples calls of the same magic word
862 $index: index (string) of the magic
863 $ret: value of the magic word (the hook should set it)
865 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
866 $parser: Parser object
867 $time: actual time (timestamp)
869 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
870 $parser: Parser object
871 $varCache: varaiable cache (array)
873 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
874 $parser: Parser object
875 $limitReport: text that will be included (without comment tags)
877 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
878 $title: title object representing the file
879 $file: file object that will be used to create the image
880 &$params: 2-D array of parameters
882 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
883 $parser: Parser object created
885 'ParserTestTables': alter the list of tables to duplicate when parser tests
886 are run. Use when page save hooks require the presence of custom tables
887 to ensure that tests continue to run properly.
888 &$tables: array of table names
890 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
891 my talk page, my contributions" etc).
893 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
894 &$title: Title object representing the current page
896 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
897 &$user : User performing the action
898 $action : Action being performed
899 &$result : Whether or not the action should be prevented
900 Change $result and return false to give a definitive answer, otherwise
901 the built-in rate limiting checks are used, if enabled.
903 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
904 $form : PreferencesForm object
905 &$html : HTML to append to
907 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
908 AJAX search suggestions. Put results into &$results outparam and return false.
909 $ns : array of int namespace keys to search in
910 $search : search term (not guaranteed to be conveniently normalized)
911 $limit : maximum number of results to return
912 &$results : out param: array of page names (strings)
914 'PrefsEmailAudit': called when user changes his email address
915 $user: User (object) changing his email address
916 $oldaddr: old email address (string)
917 $newaddr: new email address (string)
919 'PrefsPasswordAudit': called when user changes his password
920 $user: User (object) changing his passoword
921 $newPass: new password
922 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
924 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
925 &$obj: RawPage object
926 &$text: The text that's going to be the output
928 'RecentChange_save': called at the end of RecenChange::save()
929 $recentChange: RecentChange object
931 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
932 $form: the PreferencesForm
933 $out: output page to render to, probably $wgOut
935 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
936 $form: the PreferencesForm
937 $user: the User object to load preferences from
939 'RevisionInsertComplete': called after a revision is inserted into the DB
940 $revision: the Revision
942 'SavePreferences': called at the end of PreferencesForm::savePreferences;
943 returning false prevents the preferences from being saved.
944 $form: the PreferencesForm
945 $user: the User object to save preferences to
946 $message: change this to set an error message (ignored if the hook does not return false)
947 $old: old preferences of the user
949 'SearchUpdate': Prior to search update completion
951 $namespace : Page namespace
953 $text : Current text being indexed
955 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
956 $term : Search term string
957 &$title : Outparam; set to $title object and return false for a match
959 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
960 $text: Text being shown
961 $title: Title of the custom script/stylesheet page
962 $output: Current OutputPage object
964 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
965 &$siteNotice: HTML returned as the sitenotice
966 Return true to allow the normal method of notice selection/rendering to work,
967 or change the value of $siteNotice and return false to alter it.
969 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
970 &$siteNotice: HTML sitenotice
971 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
973 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
975 &$text: bottomScripts Text
976 Append to $text to add additional text/scripts after the stock bottom scripts.
978 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
980 &$subpages: Subpage links HTML
981 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
982 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
984 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
985 $sktemplate: SkinTemplate object
986 $content_actions: array of tabs
988 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
989 $sktemplate: SkinTemplate object
990 $nav_urls: array of tabs
992 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
993 &$content_actions: Content actions
994 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
997 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
998 &$sktemplate: SkinTemplate object
999 &$tpl: Template engine object
1001 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1002 $sktemplate: SkinTemplate object
1003 $res: set to true to prevent active tabs
1005 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1008 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1009 You can either create your own array, or alter the parameters for the normal one.
1010 &$this: The SkinTemplate instance.
1011 $title: Title instance for the page.
1012 $message: Visible label of tab.
1013 $selected: Whether this is a selected tab.
1014 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1015 &$classes: Array of CSS classes to apply.
1016 &$query: Query string to add to link.
1018 &$result: Complete assoc. array if you want to return true.
1020 'SkinTemplateTabs': called when finished to build the actions tabs
1021 $sktemplate: SkinTemplate object
1022 $content_actions: array of tabs
1024 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have been rendered (useful for adding more)
1025 $tools: array of tools
1027 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1028 $id: User identifier
1030 'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
1031 $pager: The UsersPager instance
1032 $query: The query array to be returned
1034 'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
1035 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1036 $row: Database row object
1038 'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
1039 $pager: The UsersPager instance
1040 $out: The header HTML
1042 'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
1043 $pager: The UsersPager instance
1044 $out: The header HTML
1046 'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
1047 $pager: The UsersPager instance
1048 $query: The query array to be returned
1050 'SpecialMovepageAfterMove': called after moving a page
1051 $movePage: MovePageForm object
1052 $oldTitle: old title (object)
1053 $newTitle: new title (object)
1055 'SpecialPageExecuteAfterPage': called after executing a special page
1056 Warning: Not all the special pages call this hook
1057 $specialPage: SpecialPage object
1058 $par: paramter passed to the special page (string)
1059 $funct: function called to execute the special page
1061 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
1062 Warning: Not all the special pages call this hook
1063 $specialPage: SpecialPage object
1064 $par: paramter passed to the special page (string)
1065 $funct: function called to execute the special page
1067 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
1068 Warning: Not all the special pages call this hook
1069 $specialPage: SpecialPage object
1070 $par: paramter passed to the special page (string)
1071 $funct: function called to execute the special page
1073 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
1074 $list: list (array) of core special pages
1076 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
1077 $title: title object generated from the text entred by the user
1079 'SpecialSearchResults': called before search result display when there are matches
1080 $term: string of search term
1081 $titleMatches: empty or SearchResultSet object
1082 $textMatches: empty or SearchResultSet object
1084 'SpecialSearchNoResults': called before search result display when there are no matches
1085 $term: string of search term
1087 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1088 $extTypes: associative array of extensions types
1090 'TitleMoveComplete': after moving an article (title)
1093 $user: user who did the move
1094 $pageid: database ID of the page that's been moved
1095 $redirid: database ID of the created redirect
1097 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1098 $title: title object related to the revision
1099 $rev: revision (object) that will be viewed
1101 'UnknownAction': An unknown "action" has occured (useful for defining
1103 $action: action name
1104 $article: article "acted on"
1106 'UnwatchArticle': before a watch is removed from an article
1107 $user: user watching
1108 $article: article object to be removed
1110 'UnwatchArticle': after a watch is removed from an article
1111 $user: user that was watching
1112 $article: article object removed
1114 'UnwatchArticleComplete': after a watch is removed from an article
1115 $user: user that watched
1116 $article: article object that was watched
1118 'UploadForm:initial': before the upload form is generated
1119 $form: UploadForm object
1120 You might set the member-variables $uploadFormTextTop and
1121 $uploadFormTextAfterSummary to inject text (HTML) either before
1122 or after the editform.
1124 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1125 $form: UploadForm object
1126 Lets you poke at member variables like $mUploadDescription before the
1129 'UploadVerification': additional chances to reject an uploaded file
1130 string $saveName: destination file name
1131 string $tempName: filesystem path to the temporary file for checks
1132 string &$error: output: HTML error to show if upload canceled by returning false
1134 'UploadComplete': Upon completion of a file upload
1135 $uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
1137 'UserArrayFromResult': called when creating an UserArray object from a database result
1138 &$userArray: set this to an object to override the default object returned
1139 $res: database result used to create the object
1141 'userCan': To interrupt/advise the "user can do X to Y article" check.
1142 If you want to display an error message, try getUserPermissionsErrors.
1143 $title: Title object being checked against
1144 $user : Current user object
1145 $action: Action being checked
1146 $result: Pointer to result returned if hook returns false. If null is returned,
1147 userCan checks are continued by internal code.
1149 'UserCanSendEmail': To override User::canSendEmail() permission check
1150 $user: User (object) whose permission is being checked
1151 &$canSend: bool set on input, can override on output
1154 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1155 $user: User (object) that'll clear the message
1157 'UserCreateForm': change to manipulate the login form
1158 $template: SimpleTemplate instance for the form
1160 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1161 $user: User to get groups for
1162 &$groups: Current effective groups
1164 'UserGetAllRights': after calculating a list of all available rights
1165 &$rights: Array of rights, which may be added to.
1167 'UserGetEmail': called when getting an user email address
1169 &$email: email, change this to override local email
1171 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of email authentification
1173 &$timestamp: timestamp, change this to override local email authentification timestamp
1175 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1176 &$groups: List of implicit (automatically-assigned) groups
1178 'UserGetRights': Called in User::getRights()
1179 $user: User to get rights for
1180 &$rights: Current rights
1182 'UserLoadFromSession': called to authenticate users on external/environmental means
1183 $user: user object being loaded
1184 &$result: set this to a boolean value to abort the normal authentification process
1186 'UserLoginComplete': after a user has logged in
1187 $user: the user object that was created on login
1188 $inject_html: Any HTML to inject after the "logged in" message.
1190 'UserLoginForm': change to manipulate the login form
1191 $template: SimpleTemplate instance for the form
1193 'UserLogout': before a user logs out
1194 $user: the user object that is about to be logged out
1196 'UserLogoutComplete': after a user has logged out
1197 $user: the user object _after_ logout (won't have name, ID, etc.)
1198 $inject_html: Any HTML to inject after the "logged out" message.
1200 'UserRights': After a user's group memberships are changed
1201 $user : User object that was changed
1202 $add : Array of strings corresponding to groups added
1203 $remove: Array of strings corresponding to groups removed
1205 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1206 $user: user retrieving new talks messages
1207 $talks: array of new talks page(s)
1209 'UserSaveSettings': called when saving user settings
1212 'UserSetEmail': called when changing user email address
1214 &$email: new email, change this to override new email address
1216 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp of email authentification
1218 &$timestamp: new timestamp, change this to override local email authentification timestamp
1220 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1221 $toggles: array of toggles to add
1223 'WatchArticle': before a watch is added to an article
1224 $user: user that will watch
1225 $article: article object to be watched
1227 'WatchArticleComplete': after a watch is added to an article
1228 $user: user that watched
1229 $article: article object watched
1231 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1232 $query: $wgQueryPages itself
1234 More hooks might be available but undocumented, you can execute
1235 ./maintenance/findhooks.php to find hidden one.