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.
Expanded class hierarchy of CKEditorPluginButtonsInterface
All classes that implement CKEditorPluginButtonsInterface
CKEditorPluginContextualInterface
CKEditorPluginConfigurableInterface
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CKEditorPluginButtonsInterface:: |
public | function | Returns the buttons that this plugin provides, along with metadata. | 4 |
CKEditorPluginInterface:: |
public | function | Returns the additions to CKEDITOR.config for a specific CKEditor instance. | 3 |
CKEditorPluginInterface:: |
public | function | Returns the Drupal root-relative file path to the plugin JavaScript file. | 3 |
CKEditorPluginInterface:: |
public | function | Indicates if this plugin is part of the optimized CKEditor build. | 2 |
PluginInspectionInterface:: |
public | function | Returns the definition of the plugin implementation. | 1 |
PluginInspectionInterface:: |
public | function | Returns the plugin_id of the plugin instance. | 1 |