Manual:Hooks/EditPage::showStandardInputs:options

From MediaWiki.org
Jump to: navigation, search
EditPage::showStandardInputs:options
Available from version 1.21.0 (Gerrit change 32675)
Allows injection of form fields into the editOptions area
Define function:
public static function onEditPage_showStandardInputs_options( $editor, $out, &$tabindex ) { ... }
Attach hook:

In extension.json:

{
	"Hooks": {
		"EditPage::showStandardInputs:options": "MyExtensionHooks::onEditPageshowStandardInputsoptions"
	}
}

For MediaWiki ≤1.25:

$wgHooks['EditPage::showStandardInputs:options'][] = 'MyExtensionHooks::onEditPageshowStandardInputsoptions';
Called from: File(s): EditPage.php

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

Details[edit]

  • $editor: EditPage instance
  • $out: OutputPage instance to write to
  • &$tabindex: HTML tabindex of the last edit check/button. Should be preincremented if necessary.

The return value is ignored, and should always be true.

Purpose[edit]

If an extension needs to add something more than a button or checkboxes to the "edit options" area below the edit form, this extension may be used.