mediawiki-extensions-Visual.../includes/VisualEditorBeforeEditorHook.php
Ed Sanders 02cfb4bf71 Introduce VisualEditorBeforeEditorHook
Extensions can return false in this hook to disable VE on specific pages.

Bug: T174180
Change-Id: I764843fcfc07149c50ae6af758df43ca454d3296
2022-02-01 17:57:27 +00:00

34 lines
617 B
PHP

<?php
namespace MediaWiki\Extension\VisualEditor;
use OutputPage;
use Skin;
/**
* VisualEditorBeforeEditorHook
*
* @file
* @ingroup Extensions
* @copyright 2011-2021 VisualEditor Team and others; see AUTHORS.txt
* @license MIT
*/
interface VisualEditorBeforeEditorHook {
/**
* This hook is executed in before deciding if the editor is available on a certain page
*
* If the hook returns false, the editor is not available.
*
* @param OutputPage $output
* @param Skin $skin
* @return bool
*/
public function onVisualEditorBeforeEditorHook(
OutputPage $output,
Skin $skin
): bool;
}