3 This document describes how event hooks work in MediaWiki; how to add hooks for
4 an event; and how to run hooks for an event.
9 Something that happens with the wiki. For example: a user logs in. A wiki
10 page is saved. A wiki page is deleted. Often there are two events
11 associated with a single action: one before the code is run to make the
12 event happen, and one after. Each event has a name, preferably in
13 CamelCase. For example, 'UserLogin', 'ArticleSave', 'ArticleSaveComplete',
17 A clump of code and data that should be run when an event happens. This can
18 be either a function and a chunk of data, or an object and a method.
21 The function part of a hook.
25 Hooks allow us to decouple optionally-run code from code that is run for
26 everyone. It allows MediaWiki hackers, third-party developers and local
27 administrators to define code that will be run at certain points in the mainline
28 code, and to modify the data run by that mainline code. Hooks can keep mainline
29 code simple, and make it easier to write extensions. Hooks are a principled
30 alternative to local patches.
32 Consider, for example, two options in MediaWiki. One reverses the order of a
33 title before displaying the article; the other converts the title to all
34 uppercase letters. Currently, in MediaWiki code, we would handle this as follows
35 (note: not real code, here):
37 function showAnArticle($article) {
38 global $wgReverseTitle, $wgCapitalizeTitle;
40 if ($wgReverseTitle) {
41 wfReverseTitle($article);
44 if ($wgCapitalizeTitle) {
45 wfCapitalizeTitle($article);
48 # code to actually show the article goes here
51 An extension writer, or a local admin, will often add custom code to the
52 function -- with or without a global variable. For example, someone wanting
53 email notification when an article is shown may add:
55 function showAnArticle($article) {
56 global $wgReverseTitle, $wgCapitalizeTitle, $wgNotifyArticle;
58 if ($wgReverseTitle) {
59 wfReverseTitle($article);
62 if ($wgCapitalizeTitle) {
63 wfCapitalizeTitle($article);
66 # code to actually show the article goes here
68 if ($wgNotifyArticle) {
69 wfNotifyArticleShow($article));
73 Using a hook-running strategy, we can avoid having all this option-specific
74 stuff in our mainline code. Using hooks, the function becomes:
76 function showAnArticle($article) {
78 if (wfRunHooks('ArticleShow', array(&$article))) {
80 # code to actually show the article goes here
82 wfRunHooks('ArticleShowComplete', array(&$article));
86 We've cleaned up the code here by removing clumps of weird, infrequently used
87 code and moving them off somewhere else. It's much easier for someone working
88 with this code to see what's _really_ going on, and make changes or fix bugs.
90 In addition, we can take all the code that deals with the little-used
91 title-reversing options (say) and put it in one place. Instead of having little
92 title-reversing if-blocks spread all over the codebase in showAnArticle,
93 deleteAnArticle, exportArticle, etc., we can concentrate it all in an extension
96 function reverseArticleTitle($article) {
100 function reverseForExport($article) {
104 The setup function for the extension just has to add its hook functions to the
107 setupTitleReversingExtension() {
110 $wgHooks['ArticleShow'][] = 'reverseArticleTitle';
111 $wgHooks['ArticleDelete'][] = 'reverseArticleTitle';
112 $wgHooks['ArticleExport'][] = 'reverseForExport';
115 Having all this code related to the title-reversion option in one place means
116 that it's easier to read and understand; you don't have to do a grep-find to see
117 where the $wgReverseTitle variable is used, say.
119 If the code is well enough isolated, it can even be excluded when not used --
120 making for some slight savings in memory and load-up performance at runtime.
121 Admins who want to have all the reversed titles can add:
123 require_once('extensions/ReverseTitle.php');
125 ...to their LocalSettings.php file; those of us who don't want or need it can
128 The extensions don't even have to be shipped with MediaWiki; they could be
129 provided by a third-party developer or written by the admin him/herself.
133 A hook is a chunk of code run at some particular event. It consists of:
135 * a function with some optional accompanying data, or
136 * an object with a method and some optional accompanying data.
138 Hooks are registered by adding them to the global $wgHooks array for a given
139 event. All the following are valid ways to define hooks:
141 $wgHooks['EventName'][] = 'someFunction'; # function, no data
142 $wgHooks['EventName'][] = array('someFunction', $someData);
143 $wgHooks['EventName'][] = array('someFunction'); # weird, but OK
145 $wgHooks['EventName'][] = $object; # object only
146 $wgHooks['EventName'][] = array($object, 'someMethod');
147 $wgHooks['EventName'][] = array($object, 'someMethod', $someData);
148 $wgHooks['EventName'][] = array($object); # weird but OK
150 When an event occurs, the function (or object method) will be called with the
151 optional data provided as well as event-specific parameters. The above examples
152 would result in the following code being executed when 'EventName' happened:
155 someFunction($param1, $param2)
157 someFunction($someData, $param1, $param2)
160 $object->onEventName($param1, $param2)
162 $object->someMethod($param1, $param2)
163 # object with method and data
164 $object->someMethod($someData, $param1, $param2)
166 Note that when an object is the hook, and there's no specified method, the
167 default method called is 'onEventName'. For different events this would be
168 different: 'onArticleSave', 'onUserLogin', etc.
170 The extra data is useful if we want to use the same function or object for
171 different purposes. For example:
173 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'TimStarling');
174 $wgHooks['ArticleSaveComplete'][] = array('ircNotify', 'brion');
176 This code would result in ircNotify being run twice when an article is saved:
177 once for 'TimStarling', and once for 'brion'.
179 Hooks can return three possible values:
181 * true: the hook has operated successfully
182 * "some string": an error occurred; processing should stop and the error
183 should be shown to the user
184 * false: the hook has successfully done the work necessary and the calling
187 The last result would be for cases where the hook function replaces the main
188 functionality. For example, if you wanted to authenticate users to a custom
189 system (LDAP, another PHP program, whatever), you could do:
191 $wgHooks['UserLogin'][] = array('ldapLogin', $ldapServer);
193 function ldapLogin($username, $password) {
198 Returning false makes less sense for events where the action is complete, and
199 will normally be ignored.
203 A calling function or method uses the wfRunHooks() function to run the hooks
204 related to a particular event, like so:
210 if (wfRunHooks('ArticleProtect', array(&$this, &$wgUser))) {
211 # protect the article
212 wfRunHooks('ArticleProtectComplete', array(&$this, &$wgUser));
217 wfRunHooks() returns true if the calling function should continue processing
218 (the hooks ran OK, or there are no hooks to run), or false if it shouldn't (an
219 error occurred, or one of the hooks handled the action already). Checking the
220 return value matters more for "before" hooks than for "complete" hooks.
222 Note that hook parameters are passed in an array; this is a necessary
223 inconvenience to make it possible to pass reference values (that can be changed)
224 into the hook code. Also note that earlier versions of wfRunHooks took a
225 variable number of arguments; the array() calling protocol came about after
228 ==Events and parameters==
230 This is a list of known events and parameters; please add to it if you're going
231 to add events to the MediaWiki code.
233 'AbortAutoblock': Return false to cancel an autoblock.
234 $autoblockip: The IP going to be autoblocked.
235 $block: The block from which the autoblock is coming.
237 'AbortLogin': Return false to cancel account login.
238 $user: the User object being authenticated against
239 $password: the password being submitted, not yet checked for validity
240 &$retval: a LoginForm class constant to return from authenticateUserData();
241 default is LoginForm::ABORTED. Note that the client may be using
242 a machine API rather than the HTML user interface.
244 'AbortMove': allows to abort moving an article (title)
247 $user: user who is doing the move
249 $reason: the reason for the move (added in 1.13)
251 'AbortNewAccount': Return false to cancel account creation.
252 $user: the User object about to be created (read-only, incomplete)
253 $message: out parameter: error message to display on abort
255 'AddNewAccount': after a user account is created
256 $user: the User object that was created. (Parameter added in 1.7)
257 $byEmail: true when account was created "by email" (added in 1.12)
259 'AjaxAddScript': Called in output page just before the initialisation
260 of the javascript ajax engine. The hook is only called when ajax
261 is enabled ( $wgUseAjax = true; ).
263 'AlternateEdit': before checking if an user can edit a page and
264 before showing the edit form ( EditPage::edit() ). This is triggered
266 $EditPage : the EditPage object
268 'AlternateSkinPreferences': before creating the content of the 'skin'
270 $prefsform : the PreferencesForm object
272 'APIEditBeforeSave': before saving a page with api.php?action=edit,
273 after processing request parameters. Return false to let the request
274 fail, returning an error message or an <edit result="Failure"> tag
275 if $resultArr was filled.
276 $EditPage : the EditPage object
277 $text : the new text of the article (has yet to be saved)
278 $resultArr : data in this array will be added to the API result
280 'APIQueryInfoTokens': use this hook to add custom tokens to prop=info.
281 Every token has an action, which will be used in the intoken parameter
282 and in the output (actiontoken="..."), and a callback function which
283 should return the token, or false if the user isn't allowed to obtain
284 it. The prototype of the callback function is func($pageid, $title)
285 where $pageid is the page ID of the page the token is requested for
286 and $title is the associated Title object. In the hook, just add
287 your callback to the $tokenFunctions array and return true (returning
288 false makes no sense)
289 $tokenFunctions: array(action => callback)
291 'APIQueryRevisionsTokens': use this hook to add custom tokens to prop=revisions.
292 Every token has an action, which will be used in the rvtoken parameter
293 and in the output (actiontoken="..."), and a callback function which
294 should return the token, or false if the user isn't allowed to obtain
295 it. The prototype of the callback function is func($pageid, $title, $rev)
296 where $pageid is the page ID of the page associated to the revision the
297 token is requested for, $title the associated Title object and $rev the
298 associated Revision object. In the hook, just add your callback to the
299 $tokenFunctions array and return true (returning false makes no sense)
300 $tokenFunctions: array(action => callback)
302 'ArticleAfterFetchContent': after fetching content of an article from the database
303 $article: the article (object) being loaded from the database
304 $content: the content (string) of the article
306 'ArticleDelete': before an article is deleted
307 $article: the article (object) being deleted
308 $user: the user (object) deleting the article
309 $reason: the reason (string) the article is being deleted
310 $error: if the deletion was prohibited, the (raw HTML) error message to display
313 'ArticleDeleteComplete': after an article is deleted
314 $article: the article that was deleted
315 $user: the user that deleted the article
316 $reason: the reason the article was deleted
317 $id: id of the article that was deleted
319 'ArticleEditUpdateNewTalk': before updating user_newtalk when a user talk page was changed
320 $article: article (object) of the user talk page
322 'ArticleEditUpdatesDeleteFromRecentchanges': before deleting old entries from recentchanges table, return false to not delete old entries
323 $article: article (object) being modified
325 'ArticleFromTitle': when creating an article object from a title object using Wiki::articleFromTitle()
326 $title: title (object) used to create the article object
327 $article: article (object) that will be returned
329 'ArticleInsertComplete': After a new article is created
330 $article: Article created
331 $user: User creating the article
333 $summary: Edit summary/comment
334 $isMinor: Whether or not the edit was marked as minor
335 $isWatch: (No longer used)
336 $section: (No longer used)
337 $flags: Flags passed to Article::doEdit()
338 $revision: New Revision of the article
340 'ArticleMergeComplete': after merging to article using Special:Mergehistory
341 $targetTitle: target title (object)
342 $destTitle: destination title (object)
344 'ArticlePageDataAfter': after loading data of an article from the database
345 $article: article (object) whose data were loaded
346 $row: row (object) returned from the database server
348 'ArticlePageDataBefore': before loading data of an article from the database
349 $article: article (object) that data will be loaded
350 $fields: fileds (array) to load from the database
352 'ArticleProtect': before an article is protected
353 $article: the article being protected
354 $user: the user doing the protection
355 $protect: boolean whether this is a protect or an unprotect
356 $reason: Reason for protect
357 $moveonly: boolean whether this is for move only or not
359 'ArticleProtectComplete': after an article is protected
360 $article: the article that was protected
361 $user: the user who did the protection
362 $protect: boolean whether it was a protect or an unprotect
363 $reason: Reason for protect
364 $moveonly: boolean whether it was for move only or not
366 'ArticlePurge': before executing "&action=purge"
367 $article: article (object) to purge
369 'ArticleRevisionVisiblitySet': called when changing visibility of one or more
370 revision of an article
371 &$title: title object of the article
373 'ArticleRevisionUndeleted': after an article revision is restored
374 $title: the article title
375 $revision: the revision
376 $oldPageID: the page ID of the revision when archived (may be null)
378 'ArticleRollbackComplete': after an article rollback is completed
379 $article: the article that was edited
380 $user: the user who did the rollback
381 $revision: the revision the page was reverted back to
383 'ArticleSave': before an article is saved
384 $article: the article (object) being saved
385 $user: the user (object) saving the article
386 $text: the new article text
387 $summary: the article summary (comment)
392 'ArticleSaveComplete': After an article has been updated
393 $article: Article modified
394 $user: User performing the modification
396 $summary: Edit summary/comment
397 $isMinor: Whether or not the edit was marked as minor
398 $isWatch: (No longer used)
399 $section: (No longer used)
400 $flags: Flags passed to Article::doEdit()
401 $revision: New Revision of the article
403 'ArticleSaveComplete': after an article is saved
404 $article: the article (object) saved
405 $user: the user (object) who saved the article
406 $text: the new article text
407 $summary: the article summary (comment)
412 wfRunHooks( 'ArticleSaveComplete', array( &$this, &$wgUser, $text, $summary, $flags & EDIT_MINOR, null, null, &$flags, $revision ) );
414 'ArticleUndelete': When one or more revisions of an article are restored
415 $title: Title corresponding to the article restored
416 $create: Whether or not the restoration caused the page to be created
417 (i.e. it didn't exist before)
419 'ArticleUpdateBeforeRedirect': After a page is updated (usually on save), before the user is redirected back to the page
420 &$article: the article
421 &$sectionanchor: The section anchor link (e.g. "#overview" )
422 &$extraq: Extra query parameters which can be added via hooked functions
424 'ArticleViewHeader': Before the parser cache is about to be tried for article viewing.
425 &$article: the article
426 &$pcache: whether to try the parser cache or not
427 &$outputDone: whether the output for this page finished or not
429 'ArticleViewRedirect': before setting "Redirected from ..." subtitle when follwed an redirect
430 $article: target article (object)
432 'AuthPluginAutoCreate': Called when creating a local account for an user logged
433 in from an external authentication method
434 $user: User object created locally
436 'AuthPluginSetup': update or replace authentication plugin object ($wgAuth)
437 Gives a chance for an extension to set it programattically to a variable class.
438 &$auth: the $wgAuth object, probably a stub
440 'AutopromoteCondition': check autopromote condition for user.
441 $type: condition type
444 $result: result of checking autopromote condition
446 'BadImage': When checking against the bad image list
447 $name: Image name being checked
448 &$bad: Whether or not the image is "bad"
450 Change $bad and return false to override. If an image is "bad", it is not
451 rendered inline in wiki pages or galleries in category pages.
453 'BeforeGalleryFindFile': before an image is fetched for a gallery
454 &$gallery,: the gallery object
455 &$nt: the image title
456 &$time: image timestamp
458 'BeforePageDisplay': Prior to outputting a page
459 &$out: OutputPage object
462 'BeforeParserFetchTemplateAndtitle': before a template is fetched by Parser
463 &$parser: Parser object
464 &$title: title of the template
465 &$skip: skip this template and link it?
466 &$id: the id of the revision being parsed
468 'BeforeParserMakeImageLinkObj': before an image is rendered by Parser
469 &$parser: Parser object
470 &$nt: the image title
471 &$skip: skip this image and link it?
472 &$time: the image timestamp
474 'BeforeParserrenderImageGallery': before an image gallery is rendered by Parser
475 &$parser: Parser object
476 &$ig: ImageGallery object
478 'BeforeWatchlist': Override watchlist display or add extra SQL clauses.
479 $nondefaults: Assoc array with the following keys:
480 days, hideOwn, hideBots, hideMinor, namespace
482 &$hookSql: a string which will be inserted without sanitation into the SQL query
483 used to get the watchlist, at the end of the WHERE part.
485 'BlockIp': before an IP address or user is blocked
486 $block: the Block object about to be saved
487 $user: the user _doing_ the block (not the one being blocked)
489 'BlockIpComplete': after an IP address or user is blocked
490 $block: the Block object that was saved
491 $user: the user who did the block (not the one being blocked)
493 'BookInformation': Before information output on Special:Booksources
494 $isbn: ISBN to show information for
495 $output: OutputPage object in use
497 'BrokenLink': Before the HTML is created for a broken (i.e. red) link
498 &$linker: Linker instance
500 $query: the URL query string passed in
501 &$u: the URL of this link
502 &$style: the inline CSS style
503 &$prefix: a prefix prepended to the linked text
504 &$text: the text placed by the user in the wiki-link
505 &$inside: any additional alphanumeric characters placed after the wiki-link,
506 that are made part of the link text
507 &$trail: text placed immediately after the HTML link
509 'CategoryPageView': before viewing a categorypage in CategoryPage::view
510 $catpage: CategoryPage instance
512 'ChangesListInsertArticleLink': Override or augment link to article in RC list.
513 &$this: ChangesList instance.
514 &$articlelink: HTML of link to article (already filled-in).
515 &$s: HTML of row that is being constructed.
516 &$rc: RecentChange instance.
517 $unpatrolled: Whether or not we are showing unpatrolled changes.
518 $watched: Whether or not the change is watched by the user.
520 'ContribsPager::getQueryInfo': Before the contributions query is about to run
521 &$pager: Pager object for contributions
522 &queryInfo: The query for the contribs Pager
524 'ContributionsLineEnding': Called before a contributions HTML line is finished
525 $page: SpecialPage object for contributions
527 $row: the DB row for this line
529 'ContributionsToolLinks': Change tool links above Special:Contributions
531 $title: User page title
532 &$tools: Array of tool links
534 'CustomEditor': When invoking the page editor
535 $article: Article being edited
536 $user: User performing the edit
538 Return true to allow the normal editor to be used, or false
539 if implementing a custom editor, e.g. for a special namespace,
542 'DiffViewHeader': called before diff display
543 $diff: DifferenceEngine object that's calling
544 $oldRev: Revision object of the "old" revision (may be null/invalid)
545 $newRev: Revision object of the "new" revision
547 'DisplayOldSubtitle': before creating subtitle when browsing old versions of an article
548 $article: article (object) being viewed
549 $oldid: oldid (int) being viewed
551 'EditFilter': Perform checks on an edit
552 $editor: Edit form (see includes/EditPage.php)
553 $text: Contents of the edit box
554 $section: Section being edited
555 &$error: Error message to return
556 $summary: Edit summary for page
558 'EditFilterMerged': Post-section-merge edit filter
559 $editor: EditPage instance (object)
560 $text: content of the edit box
561 $error: error message to return
562 $summary: Edit summary for page
564 'EditFormPreloadText': Allows population of the edit form when creating new pages
565 &$text: Text to preload with
566 &$title: Title object representing the page being created
568 'EditPage::attemptSave': called before an article is
569 saved, that is before insertNewArticle() is called
570 &$editpage_Obj: the current EditPage object
572 'EditPage::showEditForm:fields': allows injection of form field into edit form
573 &$editor: the EditPage instance for reference
574 &$out: an OutputPage instance to write to
575 return value is ignored (should always return true)
577 'EditPage::showEditForm:initial': before showing the edit form
578 $editor: EditPage instance (object)
580 Return false to halt editing; you'll need to handle error messages, etc. yourself.
581 Alternatively, modifying $error and returning true will cause the contents of $error
582 to be echoed at the top of the edit form as wikitext. Return true without altering
583 $error to allow the edit to proceed.
585 'EditPageBeforeConflictDiff': allows modifying the EditPage object and output
586 when there's an edit conflict. Return false to halt normal diff output; in
587 this case you're responsible for computing and outputting the entire "conflict"
588 part, i.e., the "difference between revisions" and "your text" headers and
590 &$editor: EditPage instance
591 &$out: OutputPage instance
593 'EditPageBeforeEditButtons': allows modifying the edit buttons below the textarea in the edit form
594 &$editpage: The current EditPage object
595 &$buttons: Array of edit buttons "Save", "Preview", "Live", and "Diff"
597 'EditSectionLink': Override the return value of Linker::editSectionLink()
598 $skin: Skin rendering the UI
599 $title: Title being linked to
600 $section: Section to link to
602 $result: Result (alter this to override the generated links)
604 'EditSectionLinkForOther': Override the return value of Linker::editSectionLinkForOther()
605 $skin: Skin rendering the UI
606 $title: Title being linked to
607 $section: Section to link to
608 $hint: Anchor title/tooltip attributes
610 $result: Result (alter this to override the generated links)
612 'EmailConfirmed': When checking that the user's email address is "confirmed"
613 $user: User being checked
614 $confirmed: Whether or not the email address is confirmed
615 This runs before the other checks, such as anonymity and the real check; return
616 true to allow those checks to occur, and false if checking is done.
618 'EmailUser': before sending email from one user to another
619 $to: address of receiving user
620 $from: address of sending user
621 $subject: subject of the mail
622 $text: text of the mail
624 'EmailUserComplete': after sending email from one user to another
625 $to: address of receiving user
626 $from: address of sending user
627 $subject: subject of the mail
628 $text: text of the mail
630 'FetchChangesList': When fetching the ChangesList derivative for a particular user
631 &$user: User the list is being fetched for
632 &$skin: Skin object to be used with the list
633 &$list: List object (defaults to NULL, change it to an object instance and return
634 false override the list derivative used)
636 'FileDeleteComplete': When a file is deleted
637 $file: reference to the deleted file
638 $oldimage: in case of the deletion of an old image, the name of the old file
639 $article: in case all revisions of the file are deleted a reference to the article
640 associated with the file.
641 $user: user who performed the deletion
644 'FileUpload': When a file upload occurs
645 $file : Image object representing the file that was uploaded
647 'FileUndeleteComplete': When a file is undeleted
648 $title: title object to the file
649 $fileVersions: array of undeleted versions. Empty if all versions were restored
650 $user: user who performed the undeletion
653 'GetAutoPromoteGroups': When determining which autopromote groups a user is entitled to be in.
654 &$user: user to promote.
655 &$promote: groups that will be added.
657 'GetBlockedStatus': after loading blocking status of an user from the database
658 $user: user (object) being checked
660 'GetCacheVaryCookies': get cookies that should vary cache options
661 $out: OutputPage object
662 &$cookies: array of cookies name, add a value to it if you want to add a cookie
663 that have to vary cache options
665 'GetFullURL': modify fully-qualified URLs used in redirects/export/offsite data
666 $title: Title object of page
667 $url: string value as output (out parameter, can modify)
668 $query: query options passed to Title::getFullURL()
670 'GetInternalURL': modify fully-qualified URLs used for squid cache purging
671 $title: Title object of page
672 $url: string value as output (out parameter, can modify)
673 $query: query options passed to Title::getInternalURL()
675 'GetLinkColours': modify the CSS class of an array of page links
676 $linkcolour_ids: array of prefixed DB keys of the pages linked to, indexed by page_id.
677 &$colours: (output) array of CSS classes, indexed by prefixed DB keys
679 'GetLocalURL': modify local URLs as output into page links
680 $title: Title object of page
681 $url: string value as output (out parameter, can modify)
682 $query: query options passed to Title::getLocalURL()
684 'getUserPermissionsErrors': Add a permissions error when permissions errors are
685 checked for. Use instead of userCan for most cases. Return false if the
686 user can't do it, and populate $result with the reason in the form of
687 array( messagename, param1, param2, ... ). For consistency, error messages
688 should be plain text with no special coloring, bolding, etc. to show that
689 they're errors; presenting them properly to the user as errors is done by
691 $title: Title object being checked against
692 $user : Current user object
693 $action: Action being checked
694 $result: User permissions error to add. If none, return true.
696 'getUserPermissionsErrorsExpensive': Absolutely the same, but is called only
697 if expensive checks are enabled.
699 'ImageBeforeProduceHTML': Called before producing the HTML created by a wiki
700 image insertion. You can skip the default logic entirely by returning
701 false, or just modify a few things using call-by-reference.
703 &$title: Title object of the image
704 &$file: File object, or false if it doesn't exist
705 &$frameParams: Various parameters with special meanings; see documentation in
706 includes/Linker.php for Linker::makeImageLink2
707 &$handlerParams: Various parameters with special meanings; see documentation in
708 includes/Linker.php for Linker::makeImageLink2
709 &$time: Timestamp of file in 'YYYYMMDDHHIISS' string form, or false for current
710 &$res: Final HTML output, used if you return false
713 'ImageOpenShowImageInlineBefore': Call potential extension just before showing
714 the image on an image page
715 $imagePage: ImagePage object ($this)
718 'ImagePageFileHistoryLine': called when a file history line is contructed
720 $line: the HTML of the history line
721 $css: the line CSS class
723 'ImagePageFindFile': called when fetching the file associated with an image page
724 $page: ImagePage object
726 &$displayFile: displayed File object
728 'InitializeArticleMaybeRedirect': MediaWiki check to see if title is a redirect
729 $title: Title object ($wgTitle)
731 $ignoreRedirect: boolean to skip redirect check
732 $target: Title/string of redirect target
734 'InitPreferencesForm': called at the end of PreferencesForm's constructor
735 $form: the PreferencesForm
736 $request: the web request to initialized from
738 'InternalParseBeforeLinks': during Parser's internalParse method before links but
739 after noinclude/includeonly/onlyinclude and other processing.
740 &$this: Parser object
741 &$text: string containing partially parsed text
742 &$this->mStripState: Parser's internal StripState object
744 'IsFileCacheable': Override the result of Article::isFileCacheable() (if true)
745 $article: article (object) being checked
747 'IsTrustedProxy': Override the result of wfIsTrustedProxy()
749 $result: Change this value to override the result of wfIsTrustedProxy()
751 'isValidEmailAddr': Override the result of User::isValidEmailAddr(), for ins-
752 tance to return false if the domain name doesn't match your organization
753 $addr: The e-mail address entered by the user
754 &$result: Set this and return false to override the internal checks
756 'isValidPassword': Override the result of User::isValidPassword()
757 $password: The password entered by the user
758 &$result: Set this and return false to override the internal checks
759 $user: User the password is being validated for
761 'LanguageGetMagic': Use this to define synonyms of magic words depending of the language
762 $magicExtensions: associative array of magic words synonyms
763 $lang: laguage code (string)
765 'LanguageGetSpecialPageAliases': Use to define aliases of special pages names depending of the language
766 $specialPageAliases: associative array of magic words synonyms
767 $lang: laguage code (string)
769 'LinkerMakeExternalImage': At the end of Linker::makeExternalImage() just before the return
771 &$alt: the image's alt text
772 &$img: the new image HTML (if returning false)
774 'LinkerMakeExternalLink': At the end of Linker::makeExternalLink() just before the return
776 &$text: the link text
777 &$link: the new link HTML (if returning false)
779 'LinksUpdate': At the beginning of LinksUpdate::doUpdate() just before the actual update
780 &$linksUpdate: the LinkUpdate object
782 'LinksUpdateComplete': At the end of LinksUpdate::doUpdate() when updating has completed
783 &$linksUpdate: the LinkUpdate object
785 'LinksUpdateConstructed': At the end of LinksUpdate() is contruction.
786 &$linksUpdate: the LinkUpdate object
788 'LoadAllMessages': called by MessageCache::loadAllMessages() to load extensions messages
790 'LoadExtensionSchemaUpdates': called by maintenance/updaters.inc when upgrading database schema
792 'LocalFile::getHistory': called before file history query performed
795 $fields: select fields
798 $join_conds: JOIN conditions
800 'LoginAuthenticateAudit': a login attempt for a valid user account either succeeded or failed.
801 No return data is accepted; this hook is for auditing only.
802 $user: the User object being authenticated against
803 $password: the password being submitted and found wanting
804 $retval: a LoginForm class constant with authenticateUserData() return value (SUCCESS, WRONG_PASS, etc)
806 'LogLine': Processes a single log entry on Special:Log
807 $log_type: string for the type of log entry (e.g. 'move'). Corresponds to logging.log_type
809 $log_action: string for the type of log action (e.g. 'delete', 'block', 'create2'). Corresponds
810 to logging.log_action database field.
811 $title: Title object that corresponds to logging.log_namespace and logging.log_title database fields.
812 $paramArray: Array of parameters that corresponds to logging.log_params field. Note that only $paramArray[0]
813 appears to contain anything.
814 &$comment: string that corresponds to logging.log_comment database field, and which is displayed in the UI.
815 &$revert: string that is displayed in the UI, similar to $comment.
816 $time: timestamp of the log entry (added in 1.12)
818 'LogPageValidTypes': action being logged. DEPRECATED: Use $wgLogTypes
819 &$type: array of strings
821 'LogPageLogName': name of the logging page(s). DEPRECATED: Use $wgLogNames
822 &$typeText: array of strings
824 'LogPageLogHeader': strings used by wfMsg as a header. DEPRECATED: Use $wgLogHeaders
825 &$headerText: array of strings
827 'LogPageActionText': strings used by wfMsg as a header. DEPRECATED: Use $wgLogActions
828 &$actionText: array of strings
830 'MagicWordMagicWords': When defining new magic word. DEPRECATED: Use LanguageGetMagic hook instead
831 $magicWords: array of strings
833 'MagicWordwgVariableIDs': When definig new magic words IDs. DEPRECATED: Use LanguageGetMagic hook instead
834 $variableIDs: array of strings
836 'MarkPatrolled': before an edit is marked patrolled
837 $rcid: ID of the revision to be marked patrolled
838 $user: the user (object) marking the revision as patrolled
839 $wcOnlySysopsCanPatrol: config setting indicating whether the user
840 needs to be a sysop in order to mark an edit patrolled
842 'MarkPatrolledComplete': after an edit is marked patrolled
843 $rcid: ID of the revision marked as patrolled
844 $user: user (object) who marked the edit patrolled
845 $wcOnlySysopsCanPatrol: config setting indicating whether the user
846 must be a sysop to patrol the edit
848 'MathAfterTexvc': after texvc is executed when rendering mathematics
849 $mathRenderer: instance of MathRenderer
850 $errmsg: error message, in HTML (string). Nonempty indicates failure
851 of rendering the formula
853 'MediaWikiPerformAction': Override MediaWiki::performAction().
854 Use this to do something completely different, after the basic
855 globals have been set up, but before ordinary actions take place.
861 $this: The $mediawiki object
863 'MessagesPreLoad': When loading a message from the database
864 $title: title of the message (string)
865 $message: value (string), change it to the message you want to define
867 'MonoBookTemplateToolboxEnd': Called by Monobook skin after toolbox links have been rendered (useful for adding more)
868 Note: this is only run for the Monobook skin. To add items to the toolbox
869 for all 'SkinTemplate'-type skins, use the SkinTemplateToolboxEnd hook
871 $tools: array of tools
873 'NewRevisionFromEditComplete': called when a revision was inserted due to an edit
874 $article: the article edited
875 $rev: the new revision
876 $baseID: the revision ID this was based off, if any
878 'NormalizeMessageKey': Called before the software gets the text of a message
879 (stuff in the MediaWiki: namespace), useful for changing WHAT message gets displayed
880 &$key: the message being looked up. Change this to something else to change what message gets displayed (string)
881 &$useDB: whether or not to look up the message in the database (bool)
882 &$langCode: the language code to get the message for (string) - or -
883 whether to use the content language (true) or site language (false) (bool)
884 &$transform: whether or not to expand variables and templates in the message (bool)
886 'OpenSearchUrls': Called when constructing the OpenSearch description XML.
887 Hooks can alter or append to the array of URLs for search & suggestion formats.
888 &$urls: array of associative arrays with Url element attributes
890 'OutputPageBeforeHTML': a page has been processed by the parser and
891 the resulting HTML is about to be displayed.
892 $parserOutput: the parserOutput (object) that corresponds to the page
893 $text: the text that will be displayed, in HTML (string)
895 'OutputPageParserOutput': after adding a parserOutput to $wgOut
896 $out: OutputPage instance (object)
897 $parserOutput: parserOutput instance being added in $out
899 'OutputPageMakeCategoryLinks': links are about to be generated for the page's categories.
900 Implementations should return false if they generate the category links, so the default link generation is skipped.
901 $out: OutputPage instance (object)
902 $categories: associative array, keys are category names, values are category types ("normal" or "hidden")
903 $links: array, intended to hold the result. Must be an associative array with category types as keys and arrays of HTML links as values.
905 'PageHistoryBeforeList': When a history page list is about to be constructed.
906 $article: the article that the history is loading for
908 'PageHistoryLineEnding' : right before the end <li> is added to a history line
909 $row: the revision row for this line
910 $s: the string representing this parsed line
912 'PageHistoryPager::getQueryInfo': when a history pager query parameter set is constructed
914 $queryInfo: the query parameters
916 'PageRenderingHash': alter the parser cache option hash key
917 A parser extension which depends on user options should install
918 this hook and append its values to the key.
919 $hash: reference to a hash key string which can be modified
921 'ParserAfterStrip': Same as ParserBeforeStrip
923 'ParserAfterTidy': Called after Parser::tidy() in Parser::parse()
924 $parser: Parser object being used
925 $text: text that'll be returned
927 'ParserBeforeInternalParse': called at the beginning of Parser::internalParse()
928 $parser: Parser object
930 $stripState: StripState instance being used
932 'ParserBeforeStrip': Called at start of parsing time (no more strip, deprecated ?)
933 $parser: parser object
934 $text: text being parsed
935 $stripState: stripState used (object)
937 'ParserBeforeTidy': called before tidy and custom tags replacements
938 $parser: Parser object being used
941 'ParserClearState': called at the end of Parser::clearState()
942 $parser: Parser object being cleared
944 'ParserFirstCallInit': called when the parser initialises for the first time
945 &$parser: Parser object being cleared
947 'ParserGetVariableValueSwitch': called when the parser need the value of a custom magic word
948 $parser: Parser object
949 $varCache: array to store the value in case of multiples calls of the same magic word
950 $index: index (string) of the magic
951 $ret: value of the magic word (the hook should set it)
953 'ParserGetVariableValueTs': use this to change the value of the time for the {{LOCAL...}} magic word
954 $parser: Parser object
955 $time: actual time (timestamp)
957 'ParserGetVariableValueVarCache': use this to change the value of the variable cache or return false to not use it
958 $parser: Parser object
959 $varCache: varaiable cache (array)
961 'ParserLimitReport': called at the end of Parser:parse() when the parser will include comments about size of the text parsed
962 $parser: Parser object
963 $limitReport: text that will be included (without comment tags)
965 'ParserMakeImageParams': Called before the parser make an image link, use this to modify the parameters of the image.
966 $title: title object representing the file
967 $file: file object that will be used to create the image
968 &$params: 2-D array of parameters
970 'ParserTestParser': called when creating a new instance of Parser in maintenance/parserTests.inc
971 $parser: Parser object created
973 'ParserTestTables': alter the list of tables to duplicate when parser tests
974 are run. Use when page save hooks require the presence of custom tables
975 to ensure that tests continue to run properly.
976 &$tables: array of table names
978 'PersonalUrls': Alter the user-specific navigation links (e.g. "my page,
979 my talk page, my contributions" etc).
981 &$personal_urls: Array of link specifiers (see SkinTemplate.php)
982 &$title: Title object representing the current page
984 'PingLimiter': Allows extensions to override the results of User::pingLimiter()
985 &$user : User performing the action
986 $action : Action being performed
987 &$result : Whether or not the action should be prevented
988 Change $result and return false to give a definitive answer, otherwise
989 the built-in rate limiting checks are used, if enabled.
991 'PreferencesUserInformationPanel': Add HTML bits to user information list in preferences form
992 $form : PreferencesForm object
993 &$html : HTML to append to
995 'PrefixSearchBackend': Override the title prefix search used for OpenSearch and
996 AJAX search suggestions. Put results into &$results outparam and return false.
997 $ns : array of int namespace keys to search in
998 $search : search term (not guaranteed to be conveniently normalized)
999 $limit : maximum number of results to return
1000 &$results : out param: array of page names (strings)
1002 'PrefsEmailAudit': called when user changes his email address
1003 $user: User (object) changing his email address
1004 $oldaddr: old email address (string)
1005 $newaddr: new email address (string)
1007 'PrefsPasswordAudit': called when user changes his password
1008 $user: User (object) changing his passoword
1009 $newPass: new password
1010 $error: error (string) 'badretype', 'wrongpassword', 'error' or 'success'
1012 'RawPageViewBeforeOutput': Right before the text is blown out in action=raw
1013 &$obj: RawPage object
1014 &$text: The text that's going to be the output
1016 'RecentChange_save': called at the end of RecenChange::save()
1017 $recentChange: RecentChange object
1019 'RenderPreferencesForm': called at the end of PreferencesForm::mainPrefsForm
1020 $form: the PreferencesForm
1021 $out: output page to render to, probably $wgOut
1023 'ResetPreferences': called at the end of PreferencesForm::resetPrefs
1024 $form: the PreferencesForm
1025 $user: the User object to load preferences from
1027 'RevisionInsertComplete': called after a revision is inserted into the DB
1028 &$revision: the Revision
1029 $data: the data stored in old_text. The meaning depends on $flags: if external
1030 is set, it's the URL of the revision text in external storage; otherwise,
1031 it's the revision text itself. In either case, if gzip is set, the revision
1033 $flags: a comma-delimited list of strings representing the options used. May
1034 include: utf8 (this will always be set for new revisions); gzip; external.
1036 'SavePreferences': called at the end of PreferencesForm::savePreferences;
1037 returning false prevents the preferences from being saved.
1038 $form: the PreferencesForm
1039 $user: the User object to save preferences to
1040 $message: change this to set an error message (ignored if the hook does not return false)
1041 $old: old preferences of the user
1043 'SearchUpdate': Prior to search update completion
1045 $namespace : Page namespace
1047 $text : Current text being indexed
1049 'SearchGetNearMatch': An extra chance for exact-title-matches in "go" searches
1050 $term : Search term string
1051 &$title : Outparam; set to $title object and return false for a match
1053 'ShowRawCssJs': Customise the output of raw CSS and JavaScript in page views
1054 $text: Text being shown
1055 $title: Title of the custom script/stylesheet page
1056 $output: Current OutputPage object
1058 'SiteNoticeBefore': Before the sitenotice/anonnotice is composed
1059 &$siteNotice: HTML returned as the sitenotice
1060 Return true to allow the normal method of notice selection/rendering to work,
1061 or change the value of $siteNotice and return false to alter it.
1063 'SiteNoticeAfter': After the sitenotice/anonnotice is composed
1064 &$siteNotice: HTML sitenotice
1065 Alter the contents of $siteNotice to add to/alter the sitenotice/anonnotice.
1067 'SkinAfterBottomScripts': At the end of Skin::bottomScripts()
1069 &$text: bottomScripts Text
1070 Append to $text to add additional text/scripts after the stock bottom scripts.
1072 'SkinSubPageSubtitle': At the beginning of Skin::subPageSubtitle()
1074 &$subpages: Subpage links HTML
1075 If false is returned $subpages will be used instead of the HTML subPageSubtitle() generates.
1076 If true is returned, $subpages will be ignored and the rest of subPageSubtitle() will run.
1078 'SkinTemplateBuildContentActionUrlsAfterSpecialPage': after the single tab when showing a special page
1079 $sktemplate: SkinTemplate object
1080 $content_actions: array of tabs
1082 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': after creating the "permanent link" tab
1083 $sktemplate: SkinTemplate object
1084 $nav_urls: array of tabs
1086 'SkinTemplateContentActions': Alter the "content action" links in SkinTemplates
1087 &$content_actions: Content actions
1088 [See http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/examples/Content_action.php
1091 'SkinTemplateOutputPageBeforeExec': Before SkinTemplate::outputPage() starts page output
1092 &$sktemplate: SkinTemplate object
1093 &$tpl: Template engine object
1095 'SkinTemplatePreventOtherActiveTabs': use this to prevent showing active tabs
1096 $sktemplate: SkinTemplate object
1097 $res: set to true to prevent active tabs
1099 'SkinTemplateSetupPageCss': use this to provide per-page CSS
1102 'SkinTemplateTabAction': Override SkinTemplate::tabAction().
1103 You can either create your own array, or alter the parameters for the normal one.
1104 &$this: The SkinTemplate instance.
1105 $title: Title instance for the page.
1106 $message: Visible label of tab.
1107 $selected: Whether this is a selected tab.
1108 $checkEdit: Whether or not the action=edit query should be added if appropriate.
1109 &$classes: Array of CSS classes to apply.
1110 &$query: Query string to add to link.
1112 &$result: Complete assoc. array if you want to return true.
1114 'SkinTemplateTabs': called when finished to build the actions tabs
1115 $sktemplate: SkinTemplate object
1116 $content_actions: array of tabs
1118 'SkinTemplateToolboxEnd': Called by SkinTemplate skins after toolbox links have been rendered (useful for adding more)
1119 $tools: array of tools
1121 'SpecialContributionsBeforeMainOutput': Before the form on Special:Contributions
1122 $id: User identifier
1124 'SpecialListusersDefaultQuery': called right before the end of UsersPager::getDefaultQuery()
1125 $pager: The UsersPager instance
1126 $query: The query array to be returned
1128 'SpecialListusersFormatRow': called right before the end of UsersPager::formatRow()
1129 $item: HTML to be returned. Will be wrapped in <li></li> after the hook finishes
1130 $row: Database row object
1132 'SpecialListusersHeader': called before closing the <fieldset> in UsersPager::getPageHeader()
1133 $pager: The UsersPager instance
1134 $out: The header HTML
1136 'SpecialListusersHeaderForm': called before adding the submit button in UsersPager::getPageHeader()
1137 $pager: The UsersPager instance
1138 $out: The header HTML
1140 'SpecialListusersQueryInfo': called right before the end of UsersPager::getQueryInfo()
1141 $pager: The UsersPager instance
1142 $query: The query array to be returned
1144 'SpecialMovepageAfterMove': called after moving a page
1145 $movePage: MovePageForm object
1146 $oldTitle: old title (object)
1147 $newTitle: new title (object)
1149 'SpecialPageExecuteAfterPage': called after executing a special page
1150 Warning: Not all the special pages call this hook
1151 $specialPage: SpecialPage object
1152 $par: paramter passed to the special page (string)
1153 $funct: function called to execute the special page
1155 'SpecialPageExecuteBeforeHeader': called before setting the header text of the special page
1156 Warning: Not all the special pages call this hook
1157 $specialPage: SpecialPage object
1158 $par: paramter passed to the special page (string)
1159 $funct: function called to execute the special page
1161 'SpecialPageExecuteBeforePage': called after setting the special page header text but before the main execution
1162 Warning: Not all the special pages call this hook
1163 $specialPage: SpecialPage object
1164 $par: paramter passed to the special page (string)
1165 $funct: function called to execute the special page
1167 'SpecialPage_initList': called when setting up SpecialPage::$mList, use this hook to remove a core special page
1168 $list: list (array) of core special pages
1170 'SpecialRecentChangesPanel': called when building form options in SpecialRecentChanges
1171 &$extraOpts: array of added items, to which can be added
1172 $opts: FormOptions for this request
1174 'SpecialRecentChangesQuery': called when building sql query for SpecialRecentChanges
1175 &$conds: array of where conditionals for query
1176 &$tables: array of tables to be queried
1177 &$join_conds: join conditions for the tables
1178 $opts: FormOptions for this request
1180 'SpecialSearchNogomatch': called when user clicked the "Go" button but the target doesn't exist
1181 $title: title object generated from the text entred by the user
1183 'SpecialSearchResults': called before search result display when there are matches
1184 $term: string of search term
1185 &$titleMatches: empty or SearchResultSet object
1186 &$textMatches: empty or SearchResultSet object
1188 'SpecialSearchNoResults': called before search result display when there are no matches
1189 $term: string of search term
1191 'SpecialVersionExtensionTypes': called when generating the extensions credits, use this to change the tables headers
1192 $extTypes: associative array of extensions types
1194 'TitleMoveComplete': after moving an article (title)
1197 $user: user who did the move
1198 $pageid: database ID of the page that's been moved
1199 $redirid: database ID of the created redirect
1201 'UndeleteShowRevision': called when showing a revision in Special:Undelete
1202 $title: title object related to the revision
1203 $rev: revision (object) that will be viewed
1205 'UnknownAction': An unknown "action" has occured (useful for defining
1207 $action: action name
1208 $article: article "acted on"
1210 'UnwatchArticle': before a watch is removed from an article
1211 $user: user watching
1212 $article: article object to be removed
1214 'UnwatchArticle': after a watch is removed from an article
1215 $user: user that was watching
1216 $article: article object removed
1218 'UnwatchArticleComplete': after a watch is removed from an article
1219 $user: user that watched
1220 $article: article object that was watched
1222 'UploadForm:initial': before the upload form is generated
1223 $form: UploadForm object
1224 You might set the member-variables $uploadFormTextTop and
1225 $uploadFormTextAfterSummary to inject text (HTML) either before
1226 or after the editform.
1228 'UploadForm:BeforeProcessing': at the beginning of processUpload()
1229 $form: UploadForm object
1230 Lets you poke at member variables like $mUploadDescription before the
1233 'UploadVerification': additional chances to reject an uploaded file
1234 string $saveName: destination file name
1235 string $tempName: filesystem path to the temporary file for checks
1236 string &$error: output: HTML error to show if upload canceled by returning false
1238 'UploadComplete': Upon completion of a file upload
1239 $uploadForm: Upload form object. File can be accessed by $uploadForm->mLocalFile.
1241 'UserArrayFromResult': called when creating an UserArray object from a database result
1242 &$userArray: set this to an object to override the default object returned
1243 $res: database result used to create the object
1245 'userCan': To interrupt/advise the "user can do X to Y article" check.
1246 If you want to display an error message, try getUserPermissionsErrors.
1247 $title: Title object being checked against
1248 $user : Current user object
1249 $action: Action being checked
1250 $result: Pointer to result returned if hook returns false. If null is returned,
1251 userCan checks are continued by internal code.
1253 'UserCanSendEmail': To override User::canSendEmail() permission check
1254 $user: User (object) whose permission is being checked
1255 &$canSend: bool set on input, can override on output
1258 'UserClearNewTalkNotification': called when clearing the "You have new messages!" message, return false to not delete it
1259 $user: User (object) that'll clear the message
1261 'UserCreateForm': change to manipulate the login form
1262 $template: SimpleTemplate instance for the form
1264 'UserEffectiveGroups': Called in User::getEffectiveGroups()
1265 $user: User to get groups for
1266 &$groups: Current effective groups
1268 'UserGetAllRights': after calculating a list of all available rights
1269 &$rights: Array of rights, which may be added to.
1271 'UserGetEmail': called when getting an user email address
1273 &$email: email, change this to override local email
1275 'UserGetEmailAuthenticationTimestamp': called when getting the timestamp of email authentification
1277 &$timestamp: timestamp, change this to override local email authentification timestamp
1279 'UserGetImplicitGroups': Called in User::getImplicitGroups()
1280 &$groups: List of implicit (automatically-assigned) groups
1282 'UserGetRights': Called in User::getRights()
1283 $user: User to get rights for
1284 &$rights: Current rights
1286 'UserLoadDefaults': called when loading a default user
1290 'UserLoadFromSession': called to authenticate users on external/environmental means
1291 $user: user object being loaded
1292 &$result: set this to a boolean value to abort the normal authentification process
1294 'UserLoginComplete': after a user has logged in
1295 $user: the user object that was created on login
1296 $inject_html: Any HTML to inject after the "logged in" message.
1298 'UserLoginForm': change to manipulate the login form
1299 $template: SimpleTemplate instance for the form
1301 'UserLogout': before a user logs out
1302 $user: the user object that is about to be logged out
1304 'UserLogoutComplete': after a user has logged out
1305 $user: the user object _after_ logout (won't have name, ID, etc.)
1306 $inject_html: Any HTML to inject after the "logged out" message.
1307 $oldName: name of the user before logout (string)
1309 'UserRights': After a user's group memberships are changed
1310 $user : User object that was changed
1311 $add : Array of strings corresponding to groups added
1312 $remove: Array of strings corresponding to groups removed
1314 'UserRetrieveNewTalks': called when retrieving "You have new messages!" message(s)
1315 $user: user retrieving new talks messages
1316 $talks: array of new talks page(s)
1318 'UserSaveSettings': called when saving user settings
1321 'UserSetCookies': called when setting user cookies
1323 &$session: session array, will be added to $_SESSION
1324 &$cookies: cookies array mapping cookie name to its value
1326 'UserSetEmail': called when changing user email address
1328 &$email: new email, change this to override new email address
1330 'UserSetEmailAuthenticationTimestamp': called when setting the timestamp of email authentification
1332 &$timestamp: new timestamp, change this to override local email authentification timestamp
1334 'UserToggles': called when initialising User::$mToggles, use this to add new toggles
1335 $toggles: array of toggles to add
1337 'WatchArticle': before a watch is added to an article
1338 $user: user that will watch
1339 $article: article object to be watched
1341 'WatchArticleComplete': after a watch is added to an article
1342 $user: user that watched
1343 $article: article object watched
1345 'wgQueryPages': called when initialising $wgQueryPages, use this to add new query pages to be updated with maintenance/updateSpecialPages.php
1346 $query: $wgQueryPages itself
1348 More hooks might be available but undocumented, you can execute
1349 ./maintenance/findhooks.php to find hidden one.