X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=docs%2Fhooks.txt;h=8d3660374d53e8ca8ee47b25d7c7083da93c082e;hb=bfa365a8ac4abe25a696a4ff337cb26c60748262;hp=9aa2964344e2ee2a3d890ce4a490f6b4176314ec;hpb=cc4a0ea2a260622fa0fd74ca16fecd38582a49e1;p=lhc%2Fweb%2Fwiklou.git
diff --git a/docs/hooks.txt b/docs/hooks.txt
index 9aa2964344..8d3660374d 100644
--- a/docs/hooks.txt
+++ b/docs/hooks.txt
@@ -575,6 +575,7 @@ $error: if the deletion was prohibited, the (raw HTML) error message to display
(added in 1.13)
$status: Status object, modify this to throw an error. Overridden by $error
(added in 1.20)
+$suppress: Whether this is a suppression deletion or not (added in 1.27)
'ArticleDeleteAfterSuccess': Output after an article has been deleted.
$title: Title of the article that has been deleted.
@@ -641,16 +642,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
@@ -1581,9 +1580,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.
@@ -1957,12 +1957,14 @@ $rcid: ID of the revision to be marked patrolled
$user: the user (object) marking the revision as patrolled
$wcOnlySysopsCanPatrol: config setting indicating whether the user needs to be a
sysop in order to mark an edit patrolled.
+$auto true if the edit is being marked as patrolled automatically
'MarkPatrolledComplete': After an edit is marked patrolled.
$rcid: ID of the revision marked as patrolled
$user: user (object) who marked the edit patrolled
$wcOnlySysopsCanPatrol: config setting indicating whether the user must be a
sysop to patrol the edit.
+$auto true if the edit is being marked as patrolled automatically
'MediaWikiPerformAction': Override MediaWiki::performAction(). Use this to do
something completely different, after the basic globals have been set up, but
@@ -2169,9 +2171,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
@@ -2675,8 +2678,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.
@@ -2905,6 +2910,7 @@ $term: Search term specified by the user
on the search results page. Useful for including a feedback link.
$specialSearch: SpecialSearch object ($this)
$output: $wgOut
+$term: Search term specified by the user
'SpecialSearchSetupEngine': Allows passing custom data to search engine.
$search: SpecialSearch special page object
@@ -3290,6 +3296,26 @@ when UserMailer sends an email, with a bounce handling extension.
$to: Array of MailAddress objects for the recipients
&$returnPath: The return address string
+'UserMailerSplitTo': Called in UserMailer::send() to give extensions a chance
+to split up an email with multiple the To: field into separate emails.
+$to: array of MailAddress objects; unset the ones which should be mailed separately
+
+'UserMailerTransformContent': Called in UserMailer::send() to change email contents.
+Extensions can block sending the email by returning false and setting $error.
+$to: array of MailAdresses of the targets
+$from: MailAddress of the sender
+&$body: email body, either a string (for plaintext emails) or an array with 'text' and 'html' keys
+&$error: should be set to an error message string
+
+'UserMailerTransformMessage': Called in UserMailer::send() to change email after it has gone through
+the MIME transform. Extensions can block sending the email by returning false and setting $error.
+$to: array of MailAdresses of the targets
+$from: MailAddress of the sender
+&$subject: email subject (not MIME encoded)
+&$headers: email headers (except To: and Subject:) as an array of header name => value pairs
+&$body: email body (in MIME format) as a string
+&$error: should be set to an error message string
+
'UserRemoveGroup': Called when removing a group; return false to override stock
group removal.
$user: the user object that is to have a group removed