function hook_INCLUDE_editor in Wysiwyg 6.2

Same name and namespace in other branches

1. 7.2 wysiwyg.api.php \hook_INCLUDE_editor()

Define a Wysiwyg editor library.

@todo Complete this documentation.

11 functions implement hook_INCLUDE_editor()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

wysiwyg_ckeditor_editor in editors/ckeditor.inc

Plugin implementation of hook_editor().

wysiwyg_fckeditor_editor in editors/fckeditor.inc

Plugin implementation of hook_editor().

wysiwyg_get_editor in ./wysiwyg.module

Return library information for a given editor.

wysiwyg_jwysiwyg_editor in editors/jwysiwyg.inc

Plugin implementation of hook_editor().

wysiwyg_load_editor in ./wysiwyg.module

Load an editor library and initialize basic Wysiwyg settings.

... See full list

File

./wysiwyg.api.php, line 199

Wysiwyg API documentation.

Code

function hook_INCLUDE_editor() {
  $editor['ckeditor'] = array(
    // The official, human-readable label of the editor library.
    'title' => 'CKEditor',
    // The URL to the library's homepage.
    'vendor url' => 'http://ckeditor.com',
    // The URL to the library's download page.
    'download url' => 'http://ckeditor.com/download',
    // A definition of available variants for the editor library.
    // The first defined is used by default.
    'libraries' => array(
      '' => array(
        'title' => 'Default',
        'files' => array(
          'ckeditor.js' => array(
            'preprocess' => FALSE,
          ),
        ),
      ),
      'src' => array(
        'title' => 'Source',
        'files' => array(
          'ckeditor_source.js' => array(
            'preprocess' => FALSE,
          ),
        ),
      ),
    ),
    // (optional) A callback to invoke to return additional notes for installing
    // the editor library in the administrative list/overview.
    'install note callback' => 'wysiwyg_ckeditor_install_note',
    // The minimum and maximum versions the implementation has been tested with.
    // Users will be notified if installing a version not within this range.
    'verified version range' => array(
      '1.2.3',
      '3.4.5',
    ),
    // (optional) A callback to perform migrations of the settings stored in a
    // profile when a library change has been detected. Takes a reference to a
    // settings object, the processed editor definition, the profile version and
    // the installed library version. Migrations should be performed in the
    // order changes were introduced by library versions, and the last version
    // migrated to should be returned, or FALSE if no migration was possible.
    // The returned version should be less than or equal to the highest version
    // ( and >= the lowest version) defined in 'verified version range' and
    // be as close as possible to, without passing, the installed version.
    'migrate settings callback' => 'wysiwyg_ckeditor_migrate_settings',
    // A callback to determine the library's version.
    'version callback' => 'wysiwyg_ckeditor_version',
    // A callback to return available themes/skins for the editor library.
    'themes callback' => 'wysiwyg_ckeditor_themes',
    // (optional) A callback to perform editor-specific adjustments or
    // enhancements for the administrative editor profile settings form.
    'settings form callback' => 'wysiwyg_ckeditor_settings_form',
    // (optional) A callback to return an initialization JavaScript snippet for
    // this editor library, loaded before the actual library files. The returned
    // JavaScript is executed as inline script in a primitive environment,
    // before the DOM is loaded; typically used to prime a base path and other
    // global window variables for the editor library before it is loaded.
    // All implementations should verbosely document what they are doing and
    // why that is required.
    'init callback' => 'wysiwyg_ckeditor_init',
    // A callback to convert administrative profile/editor settings into
    // JavaScript settings.
    'settings callback' => 'wysiwyg_ckeditor_settings',
    // A callback to supply definitions of available editor plugins.
    'plugin callback' => 'wysiwyg_ckeditor_plugins',
    // A callback to supply global metadata for a single native external plugin.
    'plugin meta callback' => 'wysiwyg_ckeditor_plugin_meta',
    // A callback to convert administrative plugin settings for an editor
    // profile into JavaScript settings per profile.
    'plugin settings callback' => 'wysiwyg_ckeditor_plugin_settings',
    // (optional) Defines the proxy plugin that handles plugins provided by
    // Drupal modules, which work in all editors that support proxy plugins.
    'proxy plugin' => array(
      'drupal' => array(
        'load' => TRUE,
        'proxy' => TRUE,
      ),
    ),
    // (optional) A callback to convert proxy plugin settings into JavaScript
    // settings.
    'proxy plugin settings callback' => 'wysiwyg_ckeditor_proxy_plugin_settings',
    // Defines the list of supported (minimum) versions of the editor library,
    // and the respective Drupal integration files to load.
    'versions' => array(
      '3.0.0.3665' => array(
        'js files' => array(
          'ckeditor-3.0.js',
        ),
      ),
    ),
  );
  return $editor;
}