X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=docs%2Fhooks.txt;h=2d268b8ab3b2638f3fe583ece8e0c31a6c4b6103;hb=11b77f3d52564fce296d0ab8a2866e8a6736098b;hp=5e2269abb7747826cf00f263401595624681103d;hpb=cdc391b16db021e71e6ca9c00f2b7d341c1ca5f8;p=lhc%2Fweb%2Fwiklou.git
diff --git a/docs/hooks.txt b/docs/hooks.txt
index 5e2269abb7..2d268b8ab3 100644
--- a/docs/hooks.txt
+++ b/docs/hooks.txt
@@ -641,16 +641,14 @@ $popts: parser options to be used for pre-save transformation
'ArticleProtect': Before an article is protected.
$wikiPage: the WikiPage being protected
$user: the user doing the protection
-$protect: boolean whether this is a protect or an unprotect
+$protect: Set of restriction keys
$reason: Reason for protect
-$moveonly: boolean whether this is for move only or not
'ArticleProtectComplete': After an article is protected.
$wikiPage: the WikiPage that was protected
$user: the user who did the protection
-$protect: boolean whether it was a protect or an unprotect
+$protect: Set of restriction keys
$reason: Reason for protect
-$moveonly: boolean whether it was for move only or not
'ArticlePurge': Before executing "&action=purge".
$wikiPage: WikiPage (object) to purge
@@ -662,7 +660,8 @@ $oldPageID: the page ID of the revision when archived (may be null)
'ArticleRevisionVisibilitySet': Called when changing visibility of one or more
revisions of an article.
-&$title: Title object of the article
+$title: Title object of the article
+$ids: Ids to set the visibility for
'ArticleRollbackComplete': After an article rollback is completed.
$wikiPage: the WikiPage that was edited
@@ -1271,20 +1270,21 @@ $user: User being checked
$confirmed: Whether or not the email address is confirmed
'EmailUser': Before sending email from one user to another.
-$to: address of receiving user
-$from: address of sending user
+$to: MailAddress object of receiving user
+$from: MailAddress object of sending user
$subject: subject of the mail
$text: text of the mail
+&$error: Out-param for an error
'EmailUserCC': Before sending the copy of the email to the author.
-$to: address of receiving user
-$from: address of sending user
+$to: MailAddress object of receiving user
+$from: MailAddress object of sending user
$subject: subject of the mail
$text: text of the mail
'EmailUserComplete': After sending email from one user to another.
-$to: address of receiving user
-$from: address of sending user
+$to: MailAddress object of receiving user
+$from: MailAddress object of sending user
$subject: subject of the mail
$text: text of the mail
@@ -1376,6 +1376,9 @@ $auto: The extracted part of the parsed comment before the call to the hook.
$post: Boolean, true if there is text after this autocomment
$title: An optional title object used to links to sections. Can be null.
$local: Boolean indicating whether section links should refer to local page.
+$wikiId: String containing the ID (as used by WikiMap) of the wiki from which the
+ autocomment originated; null for the local wiki. Added in 1.26, should default
+ to null in handler functions, for backwards compatibility.
'GalleryGetModes': Get list of classes that can render different modes of a
gallery.
@@ -1576,9 +1579,10 @@ $imagePage: ImagePage object ($this)
&$html: HTML for the hook to add
'ImagePageFileHistoryLine': Called when a file history line is constructed.
+$imagePage: ImagePage object ($this)
$file: the file
-$line: the HTML of the history line
-$css: the line CSS class
+&$line: the HTML of the history line
+&$css: the line CSS class
'ImagePageFindFile': Called when fetching the file associated with an image
page.
@@ -1628,6 +1632,11 @@ Return false to stop further processing of the tag
$reader: XMLReader object
$revisionInfo: Array of information
+'ImportSources': Called when reading from the $wgImportSources configuration
+variable. Can be used to lazy-load the import sources list.
+&$importSources: The value of $wgImportSources. Modify as necessary. See the
+comment in DefaultSettings.php for the detail of how to structure this array.
+
'InfoAction': When building information to display on the action=info page.
$context: IContextSource object
&$pageInfo: Array of information
@@ -1841,6 +1850,10 @@ optional localisation messages
&$ignored: Array of ignored message keys
&$optional: Array of optional message keys
+'LocalUserCreated': Called when a local user has been created
+$user: User object for the created user
+$autocreated: Boolean, whether this was an auto-creation
+
'LogEventsListGetExtraInputs': When getting extra inputs to display on
Special:Log for a specific log type
$type: String of log type being displayed
@@ -2155,9 +2168,10 @@ $article: the article that the history is loading for
$context: RequestContext object
'PageHistoryLineEnding': Right before the end is added to a history line.
-$row: the revision row for this line
-$s: the string representing this parsed line
-$classes: array containing the element classes
+$historyAction: the action object
+&$row: the revision row for this line
+&$s: the string representing this parsed line
+&$classes: array containing the element classes
'PageHistoryPager::doBatchLookups': Called after the pager query was run, before
any output is generated, to allow batch lookups for prefetching information
@@ -2176,6 +2190,7 @@ which depends on user options should install this hook and append its values to
the key.
&$confstr: reference to a hash key string which can be modified
$user: User (object) requesting the page
+&$forOptions: array of options the hash is for
'PageViewUpdates': Allow database (or other) changes to be made after a
page view is seen by MediaWiki. Note this does not capture views made
@@ -2444,10 +2459,6 @@ $context: (IContextSource) The RequestContext the skin is being created for.
$user: The user having their password expiration reset
&$newExpire: The new expiration date
-'ResetSessionID': Called from wfResetSessionID
-$oldSessionID: old session id
-$newSessionID: new session id
-
'ResourceLoaderForeignApiModules': Called from ResourceLoaderForeignApiModule.
Use this to add dependencies to 'mediawiki.ForeignApi' module when you wish
to override its behavior. See the module docs for more information.
@@ -2664,8 +2675,10 @@ $out: OutputPage object
'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink': After creating the "permanent
link" tab.
-$sktemplate: SkinTemplate object
-$nav_urls: array of tabs
+&$sktemplate: SkinTemplate object
+&$nav_urls: array of tabs
+&$revid: The revision id of the permanent link
+&$revid2: The revision id of the permanent link, second time
'SkinTemplateGetLanguageLink': After building the data for a language link from
which the actual html is constructed.
@@ -3105,7 +3118,9 @@ $descriptor: (array) the HTMLForm descriptor
'UploadFormSourceDescriptors': after the standard source inputs have been
added to the descriptor
-$descriptor: (array) the HTMLForm descriptor
+&$descriptor: (array) the HTMLForm descriptor
+&$radio: Boolean, if source type should be shown as radio button
+$selectedSourceType: The selected source type
'UploadVerification': Additional chances to reject an uploaded file. Consider
using UploadVerifyFile instead.
@@ -3200,6 +3215,12 @@ $context: IContextSource object
$user: User to get rights for
&$rights: Current rights
+'UserGroupsChanged': Called after user groups are changed.
+$user: User whose groups changed
+$added: Groups added
+$removed: Groups removed
+$performer: User who performed the change, false if via autopromotion
+
'UserIsBlockedFrom': Check if a user is blocked from a specific page (for
specific block exemptions).
$user: User in question
@@ -3217,6 +3238,14 @@ $ip: User's IP address
false if a UserGetRights hook might remove the named right.
$right: The user right being checked
+'UserIsHidden': Check if the user's name should be hidden. See User::isHidden().
+$user: User in question.
+&$hidden: Set true if the user's name should be hidden.
+
+'UserIsLocked': Check if the user is locked. See User::isLocked().
+$user: User in question.
+&$locked: Set true if the user should be locked.
+
'UserLoadAfterLoadFromSession': Called to authenticate users on external or
environmental means; occurs after session is loaded.
$user: user object being loaded
@@ -3240,6 +3269,9 @@ database.
$user: User object
&$options: Options, can be modified.
+'UserLoggedIn': Called after a user is logged in
+$user: User object for the logged-in user
+
'UserLoginComplete': After a user has logged in.
$user: the user object that was created on login
$inject_html: Any HTML to inject after the "logged in" message.
@@ -3285,8 +3317,9 @@ message(s).
$user: user retrieving new talks messages
$talks: array of new talks page(s)
-'UserRights': After a user's group memberships are changed.
-$user: User object that was changed
+'UserRights': DEPRECATED! Use UserGroupsChanged instead.
+After a user's group memberships are changed.
+&$user: User object that was changed
$add: Array of strings corresponding to groups added
$remove: Array of strings corresponding to groups removed