Merge "Fix hook documentation for ImagePageFileHistoryLine"
authorjenkins-bot <jenkins-bot@gerrit.wikimedia.org>
Fri, 25 Sep 2015 19:37:58 +0000 (19:37 +0000)
committerGerrit Code Review <gerrit@wikimedia.org>
Fri, 25 Sep 2015 19:37:58 +0000 (19:37 +0000)
1  2 
docs/hooks.txt

diff --combined docs/hooks.txt
@@@ -662,8 -662,7 +662,8 @@@ $oldPageID: the page ID of the revisio
  
  '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
@@@ -1272,21 -1271,20 +1272,21 @@@ $user: User being checke
  $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
  
@@@ -1581,9 -1579,10 +1581,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.
@@@ -1633,11 -1632,6 +1634,11 @@@ Return false to stop further processin
  $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
@@@ -1851,10 -1845,6 +1852,10 @@@ optional localisation message
  &$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
@@@ -2190,7 -2180,6 +2191,7 @@@ which depends on user options should in
  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
@@@ -2459,6 -2448,10 +2460,6 @@@ $context: (IContextSource) The RequestC
  $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.
@@@ -3116,9 -3109,7 +3117,9 @@@ $descriptor: (array) the HTMLForm descr
  
  '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.
@@@ -3213,12 -3204,6 +3214,12 @@@ $context: IContextSource objec
  $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
@@@ -3236,14 -3221,6 +3237,14 @@@ $ip: User's IP addres
  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
@@@ -3267,9 -3244,6 +3268,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.
@@@ -3315,9 -3289,8 +3316,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