Tuesday 16 July 2024

Upgrade CKEditor 4 to CKEditor 5

Upgrade CKEditor 4 to CKEditor 5 

The old CKEditor module (which integrates with CKEditor 4) has been removed from core in Drupal 10 and is replaced by a new "CKEditor 5" module that integrates with CKEditor 5. The older version still appears as 'CKEditor' when displayed, such as on the extension page.


Most Drupal sites use CKEditor 4, and must do one of the following:

  1. Switch to CKEditor 5 (strongly recommended), or
  2. Install the CKEditor 4 contributed module, which will be supported until late 2023. Choose this option only if the site has additional Drupal modules installed that provide additional CKEditor 4 plugins with no CKEditor 5 equivalents yet. (Consult the Upgrade coordination for modules providing CKEditor 4 plugins wiki page for the current status.)
            #How to upgrade from CKEditor 4 to CKEditor 5

                1. Upgrade to Drupal 9.4.4 or higher

2. Update modules providing additional CKEditor 4 plugins to the latest release of the major version you're on. Modules that have added CKEditor 5 support should provide support for both CKEditor 4 and 5, and provide an automated upgrade path (for toolbar items and plugin settings) from 4 to 5.

3. Enable the CKEditor 5 module (leave "CKEditor" module enabled) 

4. Converting text formats to use CKEditor 5

1. Go to Text Formats ⮕ Editors in the Drupal Configuration user interface and click "Configure" for each text format.

2. Under Text Editor change selection to "CKEditor 5" and click "Save configuration"

3. Text formats must be updated one at a time. This will automatically migrate your text format configuration to CKEditor 5.

4. Disable (old) "CKEditor" module.

5. Note: This will change your configuration so make sure your export it.

A contributed CKEditor 4 module is available. However, CKEditor 4 is reaching its end-of-life at the end of 2023. The contributed module will receive coordinated security releases alongside Drupal 9 core, and no other maintenance or bug fixes. Once Drupal 9 is end-of-life, core maintainers will no longer provide security coverage for the module.


Therefore, sites should only use the CKEditor 4 module if they use contributed modules extending CKEditor that have not yet been updated to work with CKEditor 5.

No comments:

Post a Comment