function CKEditorPluginContextualInterface::isEnabled

Same name in other branches
  1. 8.9.x core/modules/ckeditor/src/CKEditorPluginContextualInterface.php \Drupal\ckeditor\CKEditorPluginContextualInterface::isEnabled()

Checks if this plugin should be enabled based on the editor configuration.

The editor's settingsĀ can be retrieved via $editor->getSettings().

Parameters

\Drupal\editor\Entity\Editor $editor: A configured text editor object.

Return value

bool

5 methods override CKEditorPluginContextualInterface::isEnabled()
DrupalImageCaption::isEnabled in core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalImageCaption.php
Checks if this plugin should be enabled based on the editor configuration.
DrupalMedia::isEnabled in core/modules/ckeditor/src/Plugin/CKEditorPlugin/DrupalMedia.php
Checks if this plugin should be enabled based on the editor configuration.
Internal::isEnabled in core/modules/ckeditor/src/Plugin/CKEditorPlugin/Internal.php
Checks if this plugin should be enabled based on the editor configuration.
LlamaContextual::isEnabled in core/modules/ckeditor/tests/modules/src/Plugin/CKEditorPlugin/LlamaContextual.php
Checks if this plugin should be enabled based on the editor configuration.
LlamaContextualAndButton::isEnabled in core/modules/ckeditor/tests/modules/src/Plugin/CKEditorPlugin/LlamaContextualAndButton.php
Checks if this plugin should be enabled based on the editor configuration.

File

core/modules/ckeditor/src/CKEditorPluginContextualInterface.php, line 40

Class

CKEditorPluginContextualInterface
Defines an interface for contextually enabled CKEditor plugins.

Namespace

Drupal\ckeditor

Code

public function isEnabled(Editor $editor);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.