Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs/hooks.txt: fix incorrect description of UploadForm:* hooks

Browse source 
Hooks [UploadForm:BeforeProcessing] and [UploadForm:initial] get SpecialUpload
object as their parameter (NOT the UploadForm object).

Also replaced obsolete note "use UploadVerification and UploadVerifyFile"
with modern "use UploadVerifyUpload".

Change-Id: I09ac5b238c8619c94978bdc771653127d3a6264d
This commit is contained in:
Edward Chernenko 2018-05-30 19:48:25 +03:00
parent 133332191d
commit 54344ac962
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/hooks.txt
View file

@ -3556,11 +3556,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.
@ -3571,7 +3571,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.