Merge "docs/hooks.txt: fix incorrect description of UploadForm:* hooks"
authorjenkins-bot <jenkins-bot@gerrit.wikimedia.org>
Mon, 18 Jun 2018 18:07:33 +0000 (18:07 +0000)
committerGerrit Code Review <gerrit@wikimedia.org>
Mon, 18 Jun 2018 18:07:33 +0000 (18:07 +0000)
docs/hooks.txt

index d9b2c3e..b452b94 100644 (file)
@@ -3592,11 +3592,11 @@ $type: (string) the requested upload type
 &$className: the class name of the Upload instance to be created
 
 'UploadForm:BeforeProcessing': At the beginning of processUpload(). Lets you
-poke at member variables like $mUploadDescription before the file is saved. Do
-not use this hook to break upload processing. This will return the user to a
-blank form with no error message; use UploadVerification and UploadVerifyFile
-instead.
-&$form: UploadForm object
+poke at member variables like $mUploadDescription before the file is saved.
+Do not use this hook to break upload processing.
+This will return the user to a blank form with no error message;
+use UploadVerifyUpload or UploadVerifyFile instead.
+&$upload: SpecialUpload object
 
 'UploadForm:getInitialPageText': After the initial page text for file uploads
 is generated, to allow it to be altered.
@@ -3607,7 +3607,7 @@ $config: Config object
 'UploadForm:initial': Before the upload form is generated. You might set the
 member-variables $uploadFormTextTop and $uploadFormTextAfterSummary to inject
 text (HTML) either before or after the editform.
-&$form: UploadForm object
+&$upload: SpecialUpload object
 
 'UploadFormInitDescriptor': After the descriptor for the upload form as been
 assembled.