From 54344ac962809d4a160806147e391e7e9f3cfa51 Mon Sep 17 00:00:00 2001 From: Edward Chernenko Date: Wed, 30 May 2018 19:48:25 +0300 Subject: [PATCH 1/1] docs/hooks.txt: fix incorrect description of UploadForm:* hooks 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 --- docs/hooks.txt | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/hooks.txt b/docs/hooks.txt index 349cd4b5e6..e7f04bcc4d 100644 --- a/docs/hooks.txt +++ b/docs/hooks.txt @@ -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. -- 2.20.1