MediaWiki  master
MediaWiki\Hook\CustomEditorHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\CustomEditorHook:

Public Member Functions

 onCustomEditor ( $article, $user)
 This hook is called when invoking the page editor. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 15 of file CustomEditorHook.php.

Member Function Documentation

◆ onCustomEditor()

MediaWiki\Hook\CustomEditorHook::onCustomEditor (   $article,
  $user 
)

This hook is called when invoking the page editor.

Since
1.35
Parameters
Article$articleArticle being edited
User$userUser performing the edit
Returns
bool|void True or no return value to allow the normal editor to be used. False if implementing a custom editor, e.g. for a special namespace, etc.

Implemented in MediaWiki\HookContainer\HookRunner.


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