function editor_ckeditor_plugins in Editor 7

Retrieves the full list of installed CKEditor plugins.

Return value

array An associative array of CKEditor plugins keyed by the internal name of the plugin. Each plugin may contain the following elements (all are optional except as noted):

• location: Required for all external plugins. String path to the plugin directory relative to the Drupal installation root.
• file: Required for all external plugins. String file name of the plugin in the "location" directory.
• internal: Boolean value indicating if the plugin is part of the compressed CKEditor library package and already loaded on all instances.
• css: An array of CSS files that should be added by CKEditor. These files are used only when CKEditor is using an iframe wrapper around its content.
• enabled callback: String containing a function name that can determine if this plugin should be enabled based on the current editor configuration.
• buttons: An array of buttons that are provided by this plugin. Each button is keyed by its CKEditor button name, and contains 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, specifies an alternative file that will be used in RTL editors.
  • image_alternative: If the button does not render as an image, specifies an HTML string representing the contents of the button.
  • attributes: An array of HTML attributes which are added to the button when it is rendered in the administrative section for assembling the toolbar.
  • multiple: Boolean value indicating if the button may be added multiple times to the toolbar.
  • required_html: If the button requires certain HTML tags to be allowed, specifies an array of tags.

See also

hook_editor_ckeditor_plugins()

hook_editor_ckeditor_plugins_alter()

hook_editor_ckeditor_PLUGIN_plugin_check()

2 calls to editor_ckeditor_plugins()

editor_ckeditor_get_settings in modules/editor_ckeditor/editor_ckeditor.module

Editor JS settings callback; Add CKEditor settings to the page for a format.

editor_ckeditor_settings_form in modules/editor_ckeditor/includes/editor_ckeditor.admin.inc

Editor settings callback; Provide options for Editor CKEditor module.

1 string reference to 'editor_ckeditor_plugins'

editor_ckeditor_hook_info in modules/editor_ckeditor/editor_ckeditor.module

Implements hook_hook_info().

File

modules/editor_ckeditor/editor_ckeditor.module, line 222

Adds CKEditor as a supported editor.

Code

function editor_ckeditor_plugins() {
  $plugins = module_invoke_all('editor_ckeditor_plugins');
  drupal_alter('editor_ckeditor_plugins', $plugins);
  return $plugins;
}