wiki.techinc.nl/includes/specials/Hook/UploadForm_BeforeProcessingHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

29 lines
899 B
PHP

<?php
namespace MediaWiki\Hook;
use SpecialUpload;
// phpcs:disable Squiz.Classes.ValidClassName.NotCamelCaps
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "UploadForm:BeforeProcessing" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface UploadForm_BeforeProcessingHook {
/**
* This hook is called 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 UploadVerifyUpload or UploadVerifyFile instead.
*
* @since 1.35
*
* @param SpecialUpload $upload
* @return bool|void True or no return value to continue or false to abort
*/
public function onUploadForm_BeforeProcessing( $upload );
}