MediaWiki\Hook\BeforeWelcomeCreationHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\BeforeWelcomeCreationHook:

Public Member Functions
	onBeforeWelcomeCreation (&$welcome_creation_msg, &$injected_html)
	This hook is called before the welcomecreation message is displayed to a newly created user.

Detailed Description

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

Use the hook name "BeforeWelcomeCreation" to register handlers implementing this interface.

Stability: stable

to implement

Definition at line 12 of file BeforeWelcomeCreationHook.php.

Member Function Documentation

onBeforeWelcomeCreation()

MediaWiki\Hook\BeforeWelcomeCreationHook::onBeforeWelcomeCreation	(	&	$welcome_creation_msg,
		&	$injected_html
	)

This hook is called before the welcomecreation message is displayed to a newly created user.

Since

1.35

Parameters

string	&$welcome_creation_msg	MediaWiki message name to display on the welcome screen to a newly created user account.
string	&$injected_html	Any HTML to inject after the "logged in" message of a newly created user account

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/BeforeWelcomeCreationHook.php