Upgrade coordination for modules providing CKEditor 4 plugins

Last updated on

22 April 2024

This documentation needs work. See "Help improve this page" in the sidebar.

General advice

See https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/migration-from-ckeditor-4.html.

For determining CKEditor 5 equivalents of CKEditor 4 plugins, see the CKEditor 4 plugin equivalents page. You can also search npm for ckeditor5-plugin.

Modules with CKEditor 4 plugins

🏁 Done

(alphabetically ordered)

Drupal module	CKEditor 4 plugin	CKEditor 5 plugin	Status + issue or note	Automatic upgrade path	Usage (2022-09-18)
CKEditor Accordion	custom	custom	🏁 since 2.0.0 (issue: #3312635: CKEditor 5 readiness)	✅ yes, 🟢 with tests	~11,000
CKEditor BiDi Buttons	official	contributed	🏁 since 4.0.0 #3312442: [PP-1] Make ready for CKEditor 5	✅ yes, 🟢 with tests	~2,000
CKEditor CodeSnippet	official	official	🏁 included with Drupal core, automatic upgrade path: #3356929: Provide an upgrade path from "codesnippet" contrib CKEditor 4 plugin to "CodeBlock" core CKEditor 5 plugin	✅ yes, 🟢 with tests	~2,800
CKEditor CodeTag	official	official	🏁 included with Drupal core, automatic upgrade path: #3274278: Migrate "codetag" contrib CKEditor 4 plugin to built-in equivalent in core's CKEditor 5	✅ yes, 🟢 with tests	~450
CKEditor Details Accordion	customized but official origin	custom	🏁 since 2.1.0-alpha1 #3315791: CKEditor 5 compatability	✅ no need	~800
CKEditor Find/Replace	official	official	🏁 since 2.0.0-beta1 #3312842: CKEditor 5/D10 compatibility	✅ yes, 🟡 without tests	~1,500
CKEditor Font Size & Family	official	official	🏁 since 2.0.0-beta3 #3239667: Drupal 10 & CKEditor 5 readiness	✅ yes, 🟢 with tests	~18,000
CKEditor Non-breaking space Plugin	custom	custom	🏁 since 2.2 (issue: #3277174: CKEditor 5 compatibility)	✅ yes, 🟢 with tests	~1,500
CodeMirror	contributed	contributed	🏁 since 3.0.0-beta3 (issue: #3243437: Add CodeMirror support for CKEditor 5)	✅ yes, 🟡 without tests	~9,500
Editor Advanced Image	custom	custom	🏁 since 2.1.0 #3333406: CKEditor 5 compatibility	✅ yes, 🟢 with tests	~1,700
Editor Advanced link	N/A	custom	🏁 since 2.1.1 #3232052: Drupal 10 & CKEditor 5 readiness	✅ yes, 🟢 with tests	~80,000
Entity Embed	custom	custom	🏁 since 1.5 #3272732: Drupal 10 & CKEditor 5 readiness	✅ yes, 🟢 with tests	~70,000
IMCE	custom	custom	🏁 since 3.0.0 (issue: #3293130: CKEditor 5 integration)	✅ yes, 🟢 with tests	~57,000
Linkit	custom	custom	🏁 since 6.0.0-beta4 #3232190: CKEditor 5 readiness	✅ yes, 🟢 with tests	~85,000
MaxLength	N/A	N/A	🏁 since 2.1.0 #3267413: Countdown not working for ckeditor5	✅ yes, 🟢 with tests	~36,000
Media Directories	N/A	N/A	🏁 Alters the `entity_embed` dialog, so works after installing Entity Embed >=1.5.	N/A	~3,300
Onomasticon	N/A	N/A	🏁 since 2.1.0 #3336231: CKEditor 5 Support	✅ yes, 🟡 without tests	~200
Token Filter	custom	custom	🏁 since 2.1.0	N/A	~30,000
USWDS Ckeditor Integration	custom (multiple)	NA	🏁 since 2.0.0	✅ yes, 🟡 without tests	~70

🪦 Obsolete

(alphabetically ordered)

Drupal module	CKEditor 4 plugin	CKEditor 5 plugin	Status + issue or note	Automatic upgrade path	Usage (2022-09-18)
CKEditor Fixed Toolbar	custom	N/A	🪦 obsolete with CKEditor 5, see #3314819-2: CKEditor 5 readiness	N/A	~15
CKEditor List Style	custom	official	🪦 part of Drupal core: #3274635: [upstream] Use CKEditor 5's native <ol type> and <ul type> UX	#3326957: Make ckeditor_liststyle compatible with ckeditor5	~3,000
CKEditor Table Resize	official	N/A	🪦 obsolete with CKEditor 5, see the warning message in the description.	N/A	~325
CKEditor Table Selection	official	N/A	🪦 obsolete with CKEditor 5, see the warning message in the description.	N/A	~929
CKEditor Upload Image	official (multiple) and customised	N/A	🪦 obsolete with CKEditor 5: Drupal core's CKEditor 5 image uploading integration now uses the default upload experience!.	N/A	~2800

🙏 Ready for testing

(ordered by most usage first)

Drupal module	CKEditor 4 plugin	CKEditor 5 plugin	Status + issue or note	Automatic upgrade path	Usage (2022-09-18)
Font Awesome Icons	custom	TBD	#3274028: CKEditor 5 compatibility — new module providing better-than-before UX: `ckeditor5_icons`	available for testing	~40,000
Video embed WYSIWYG (submodule of Video embed field)	custom	custom	#3311063: Add support for Ckeditor 5	✅ yes	~124k for the main module, but probably far less use the submodule
Inline Responsive Images	custom	custom	#3317804: Compatibility with CKEditor5 (default in D10 core)	✅ no need (still to be tested)	~4,500
CKEditor mentions	official	custom	#3309677: CKEditor mentions compatible with CKEditor 5	❌ no	~130

💪 TODO

(ordered by most usage first)

Drupal module	CKEditor 4 plugin	CKEditor 5 plugin	Status + issue or note	Usage (2022-09-18)
Editor File upload	custom	custom	#3232053: Drupal 10 & CKEditor 5 readiness	~31,000
Anchor Link	official	TBD	#3206676: Start a 3.0.x branch for CKEditor Anchor Link for semantic versioning and better integration with Drupal 10, CKEditor 5, and LinkIt	~28,000
CKEditor Color Button	official		#3297106: ckeditor_font merging with ckeditor5_font, colorbutton	~24,000
CKEditor FakeObjects	official		#3262037: Plan what's needed for ckeditor 5 in Drupal 9.3+ / Drupal 10	~24,000
CKEditor Embed Plugin	all official: `embed` + `embedsemantic` + `autoembed`	official	#3341750: CKEditor 5 support?	~16,000
CKEditor Templates	official (same as "Wysiwyg API templates" module)	TBD	#3273358: CKEditor 5 support for Content Templates	~13,500
Paragraphs Features	custom	TBD	#3368047: CKEditor 5 compatibility	~12,000
CKEditor Entity Link	custom	TBD	#3312523: CKEditor 5 support: merge with Linkit?	~5,000
CKEditor Iframe	official	TBD	#3314483: Add support for CKEditor 5	~5,000
Insert	N/A	N/A	#3314446: CKEditor 5 compatibility	~4,500
CKEditor custom config	N/A	N/A	#3310751: What is this module's future with CKEditor 5?(but if you used it only for `image2_disableResizer = true`, it's now in core!)	~4,300
CKEditor Bootstrap Buttons			#3308035: Drupal 10 & CKEditor 5 Support	~4,000
URL Embed	custom	TBD	#3316376: CKEditor 5 Support	~3,800
CKEditor Templates UI	N/A	N/A	Depends on how CKEditor Templates goes.	~3,000
WYSIWYG API Template	official (same as "CKEditor Templates" module)	TBD	#3264254: Drupal 10 and ckeditor5 compatibility	~2,500
CKEditor Bootstrap Grid			Not started.	~2,000
CKEditor Widgets Bootstrap Grid	custom	TBD	#3356334: Ckeditor 5 Compliant	~2,000
CKEditor Div Manager	official		#3322722: CKEditor 5 Compatibility	~2,000
CKEditor Height	custom	TBD	#3274041: Create a D10 / CKEditor 5 version of ckeditorheight, OR better go CORE	~1,700
Footnotes	official	TBD	#3252524: Support for ckeditor 5	~1,600
CKEditor Abbreviation	custom	TBD	#3321934: Migrate to CKEditor 5 for Drupal 9.4+ / Drupal 10	~1500
CKEditor Bootstrap Table			No issue added yet	~1,200
Views Entity Embed	custom	TBD	#3307775: CKEditor 5 support	~1,200
CKEditor Table of Contents	custom	official	#3362080: Compatibility with ckeditor5	~1,000
Collapse Text	custom	TBD	#3331979: Not compatible with CKEditor 5	~800
Video Filter	custom	custom	#3307596: Add a CKEditor5 plugin for Drupal 9.3+, Drupal 10	562 (for D8+)
CKEditor Special Characters			#3322259: Migrate to CKEditor 5	~550
Editor Button Link			#3307959: CKEditor 5 readiness	~430
Cookie Content Blocker	custom			~350
CKEditor oembed	custom (multiple)	TBD		~300
GeshiFilter	official	official	#3274974: CKEditor 5 and Drupal 10 readiness	~300
CKEditor Allowed Content Rules			#3315965: CKEditor 5 readiness	~200
CKEditor Media (oEmbed) Plugin	official: `oembed`	TBD		~150
Tooltip	custom	TBD		93
CKEditor Layouts	custom	TBD		~60
CKEditor Placeholder	custom	custom	#3273754: Ckeditor5 readiness	~40
Spoiler	none	custom	#3388924: Add WYSIWYG/CKEditor 5 button for inserting spoiler

Modules with filters whose filter type was incorrect, which the CKEditor 4 → 5 upgrade path detects and complains about

This happens when a filter is used that indicates it is of the type FilterInterface::TYPE_MARKUP_LANGUAGE — usually they should've been marked as FilterInterface::TYPE_TRANSFORM_REVERSIBLE or FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE.

Drupal module providing a filter	Status + issue or note	Usage (2022-09-18)
AutoFloat	🏁 since 1.2 #3274048: CKEditor 5 compatability	~380
Glossify	🏁 since 2.0.2 #3268577: Make it compatible with CKEditor5	~1,000
Insert View	🏁 since 2.0.1 #3310922: Wrong filter type prevents this from being used with CKEditor 5	~3,000
TOC Filter	🏁 since 2.1 #3268579: Make it compatible with CKEditor5	~750
Bootstrap Utilities - Text editor filters	🏁 since 2.0.0 #3306658: CKEditor 5 readiness - Bootstrap Utilities	~500