Manual:Hooks/SpecialListusersHeaderForm

From MediaWiki.org
Jump to navigation Jump to search
SpecialListusersHeaderForm
Available from version 1.13.0
called before adding the submit button in UsersPager::getPageHeader()
Define function:
public static function onSpecialListusersHeaderForm( UsersPager &$pager, string &$beforeSubmitButtonHookOut ) { ... }
Attach hook:

In extension.json:

{
	"Hooks": {
		"SpecialListusersHeaderForm": "MyExtensionHooks::onSpecialListusersHeaderForm"
	}
}

For MediaWiki ≤1.25:

$wgHooks['SpecialListusersHeaderForm'][] = 'MyExtensionHooks::onSpecialListusersHeaderForm';
Called from:File(s): specials/pagers/UsersPager.php
Function(s): getPageHeader

For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:SpecialListusersHeaderForm extensions.

Details[edit]

  • &$pager: The UsersPager instance
  • &$beforeSubmitButtonHookOut: The header HTML