You are here

Home » API reference » Drupal 10 » CKEditorPluginButtonsInterface.php » CKEditorPluginButtonsInterface

public function CKEditorPluginButtonsInterface::getButtons in Drupal 10

Same name and namespace in other branches
  1. 8 core/modules/ckeditor/src/CKEditorPluginButtonsInterface.php \Drupal\ckeditor\CKEditorPluginButtonsInterface::getButtons()
  2. 9 core/modules/ckeditor/src/CKEditorPluginButtonsInterface.php \Drupal\ckeditor\CKEditorPluginButtonsInterface::getButtons()

Returns the buttons that this plugin provides, along with metadata.

The metadata is used by the CKEditor module to generate a visual CKEditor toolbar builder UI.

Return value

array An array of buttons that are provided by this plugin. This will only be used in the administrative section for assembling the toolbar. Each button should be keyed by its CKEditor button name (you can look up the button name up in the plugin.js file), and should contain an array of button properties, including:

  • label: A human-readable, translated button name.
  • image: An image for the button to be used in the toolbar.
  • image_rtl: If the image needs to have a right-to-left version, specify an alternative file that will be used in RTL editors.
  • image_alternative: If this button does not render as an image, specify an HTML string representing the contents of this button.
  • image_alternative_rtl: Similar to image_alternative, but a right-to-left version.
  • attributes: An array of HTML attributes which should be added to this button when rendering the button in the administrative section for assembling the toolbar.
  • multiple: Boolean value indicating if this button may be added multiple times to the toolbar. This typically is only applicable for dividers and group indicators.
3 methods override CKEditorPluginButtonsInterface::getButtons()
LlamaButton::getButtons in core/modules/ckeditor/tests/modules/src/Plugin/CKEditorPlugin/LlamaButton.php
Returns the buttons that this plugin provides, along with metadata.
LlamaContextualAndButton::getButtons in core/modules/ckeditor/tests/modules/src/Plugin/CKEditorPlugin/LlamaContextualAndButton.php
Returns the buttons that this plugin provides, along with metadata.
LlamaCss::getButtons in core/modules/ckeditor/tests/modules/src/Plugin/CKEditorPlugin/LlamaCss.php
Returns the buttons that this plugin provides, along with metadata.

File

core/modules/ckeditor/src/CKEditorPluginButtonsInterface.php, line 56

Class

CKEditorPluginButtonsInterface
Defines an interface for CKEditor plugins with buttons.

Namespace

Drupal\ckeditor

Code

public function getButtons();