MediaWiki\Specials\Hook\UploadForm_getInitialPageTextHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onUploadForm_getInitialPageText (&$pageText, $msg, $config)
	This hook is called after the initial page text for file uploads is generated.

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "UploadForm:getInitialPageText" to register handlers implementing this interface.

Stability: stable

to implement

Definition at line 15 of file UploadForm_getInitialPageTextHook.php.

Member Function Documentation

onUploadForm_getInitialPageText()

MediaWiki\Specials\Hook\UploadForm_getInitialPageTextHook::onUploadForm_getInitialPageText	(	&	$pageText,
			$msg,
			$config )

This hook is called after the initial page text for file uploads is generated.

It allows extensions to modify the initial page text.

Since

1.35

Parameters

string	&$pageText
string[]	$msg	Array of header messages
Config	$config

Returns

bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.

---

The documentation for this interface was generated from the following file:

• includes/Specials/Hook/UploadForm_getInitialPageTextHook.php