MediaWiki master
MediaWiki\Hook\SpecialCreateAccountBenefitsHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onSpecialCreateAccountBenefits (?string &$html, array $info, array &$options)
 Replace the default signup page content about the benefits of registering an account ("Wikipedia is made by people like you...") on Special:CreateAccount.
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 14 of file SpecialCreateAccountBenefitsHook.php.

Member Function Documentation

◆ onSpecialCreateAccountBenefits()

MediaWiki\Hook\SpecialCreateAccountBenefitsHook::onSpecialCreateAccountBenefits ( ?string & $html,
array $info,
array & $options )

Replace the default signup page content about the benefits of registering an account ("Wikipedia is made by people like you...") on Special:CreateAccount.

Parameters
string | null&$htmlHTML to use instead of the default .mw-createacct-benefits-container block. By default, this is null, which means the default content will be used.
array$infoArray of information:
  • context: (IContextSource) Context object.
  • form: (HTMLForm) The signup form. Read-only - the form HTML has already been generated.
array&$optionsArray of modifiable options:
  • beforeForm: (bool, default false) Whether to insert the HTML before the form. This is mainly useful on mobile (where the login form might push the benefits out of view; but also, a long benefits block might push the form out of view).
Returns
bool|void True or no return value to continue or false to abort.
Since
1.40

Implemented in MediaWiki\HookContainer\HookRunner.


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