Defines an interface for configurable CKEditor plugins.
This allows a CKEditor plugin to define a settings form. These settings can then be automatically passed on to the corresponding CKEditor instance via CKEditorPluginInterface::getConfig().
Expanded class hierarchy of CKEditorPluginConfigurableInterface
All classes that implement CKEditorPluginConfigurableInterface
CKEditorPluginButtonsInterface
CKEditorPluginContextualInterface
interface CKEditorPluginConfigurableInterface extends CKEditorPluginInterface {
/**
* Returns a settings form to configure this CKEditor plugin.
*
* If the plugin's behavior depends on extensive options and/or external data,
* then the implementing module can choose to provide a separate, global
* configuration page rather than per-text-editor settings. In that case, this
* form should provide a link to the separate settings page.
*
* @param array $form
* An empty form array to be populated with a configuration form, if any.
* @param array $form_state
* The state of the entire filter administration form.
* @param \Drupal\editor\Plugin\Core\Entity\Editor $editor
* A configured text editor object.
*
* @return array|FALSE
* A render array for the settings form, or FALSE if there is none.
*/
function settingsForm(array $form, array &$form_state, Editor $editor);
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CKEditorPluginConfigurableInterface:: |
function | Returns a settings form to configure this CKEditor plugin. | 2 | |
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 |