interface CKEditorPluginButtonsInterface

Defines an interface for CKEditor plugins with buttons.

This allows a CKEditor plugin to define which buttons it provides, so that users can configure a CKEditor toolbar instance via the toolbar builder UI. If at least one button that this plugin provides is added to the toolbar via the toolbar builder UI, then this plugin will be enabled automatically.

If a CKEditor plugin implements this interface, it can still also implement CKEditorPluginContextualInterface if it wants a button to conditionally be added as well. The downside of conditionally adding buttons is that the user cannot see these buttons in the toolbar builder UI.

Hierarchy

Expanded class hierarchy of CKEditorPluginButtonsInterface

All classes that implement CKEditorPluginButtonsInterface

See also

CKEditorPluginContextualInterface

CKEditorPluginConfigurableInterface

2 files declare their use of CKEditorPluginButtonsInterface

File

drupal/core/modules/ckeditor/lib/Drupal/ckeditor/CKEditorPluginButtonsInterface.php, line 26
Contains \Drupal\ckeditor\CKEditorPluginButtonsInterface.

Namespace

Drupal\ckeditor
View source

Members

Namesort descending Modifiers Type Description Overrides
CKEditorPluginButtonsInterface::getButtons public function Returns the buttons that this plugin provides, along with metadata. 4
CKEditorPluginInterface::getConfig public function Returns the additions to CKEDITOR.config for a specific CKEditor instance. 3
CKEditorPluginInterface::getFile public function Returns the Drupal root-relative file path to the plugin JavaScript file. 3
CKEditorPluginInterface::isInternal public function Indicates if this plugin is part of the optimized CKEditor build. 2
PluginInspectionInterface::getPluginDefinition public function Returns the definition of the plugin implementation. 1
PluginInspectionInterface::getPluginId public function Returns the plugin_id of the plugin instance. 1