Home

Awesome

Gutenberg Migration Guide

This repository documents WordPress Classic Editor customization points and their Gutenberg equivalents (if such exist). Its goal is to help WordPress developers update their plugins and themes for Gutenberg compatibility.

This README.md provides an overview to all impacted hooks (actions and filters) and TinyMCE features. Each item then has an extended document with an overview, examples of existing usage, and documentation for its Gutenberg equivalent (if any).

For the full history, see WordPress/gutenberg#4151. Please open an issue to suggest new hooks, usage examples, or other ideas for improvement.

Sections: Actions & Filters | Core Features | TinyMCE

Actions & Filters

This table documents the most common actions and filters within the Classic Editor, and whether they still exist or have direct Gutenberg equivalents.

Action / FilterStill Exists?Gutenberg Equivalent?Learn More
default_excerptYes (GB 4.1)N/A
default_contentYes (GB 4.1)N/A
default_titleYes (GB 4.1)N/A
edit_form_topNoNoneEdit Form Actions
edit_form_after_titleNoNoneEdit Form Actions
edit_form_before_permalinkNoNoneEdit Form Actions
edit_form_after_editorNoNoneEdit Form Actions
enter_title_hereYesN/A
write_your_storyYesN/A
post_updated_messagesNoNoPost Updated Messages Filter
media_buttonsNoBlock InserterMedia Buttons
post_submitbox_minor_actionsNoNonePost Submitbox Actions
post_submitbox_misc_actionsNoNonePost Submitbox Actions
post_submitbox_startNoNonePost Submitbox Actions
default_page_template_titleYesN/A
page_attributes_dropdown_pages_argsNoNoneDropdown Pages Args Filters
quick_edit_dropdown_pages_argsNoNoneDropdown Pages Args Filters
admin_post_thumbnail_htmlNoeditor.PostFeaturedImagePost Thumbnail HTML Filter
admin_post_thumbnail_sizeNoeditor.PostFeaturedImage.imageSizePost Thumbnail Size Filter
mce_cssNoEnqueue StylesheetMCE CSS Filter
image_send_to_editorNoNoneImage Send To Editor Filter
post_galleryNoNonePost Gallery Filter

Core Features

This table documents common features within the Classic Editor, and whether they still exist or have direct Gutenberg equivalents.

FeatureStill Exists?Gutenberg Equivalent?Learn More
Editor StylesheetsNoEnqueue StylesheetEditor Stylesheets
Custom Post StatusesNoNoneCustom Post Statuses
Custom Fields MetaboxNoNoneCustom Fields Metabox
Media TabsNoNoneMedia Tabs
Post Type SupportsYesN/APost Type Supports
Screen OptionsNoNoneScreen Options

TinyMCE

This table documents common TinyMCE customizations and whether they have direct Gutenberg equivalents.

CustomizationStill Exists?Gutenberg Equivalent?Learn More
dom.DOMUtilsNoNoneTinyMCE dom.DOMUTils
EditorNoNoneTinyMCE Editor
mce_buttonsYesN/ATinyMCE Filters
mce_buttons_2YesN/ATinyMCE Filters
mce_buttons_3YesN/ATinyMCE Filters
mce_buttons_4YesN/ATinyMCE Filters
style_formatsPartiallyN/ATinyMCE Style Formats
tiny_mce_before_initYesN/ATinyMCE Filters
tiny_mce_pluginsYesN/ATinyMCE Filters
tiny_mce_external_pluginsYesN/ATinyMCE Filters
Toolbar ButtonNoNoneTinyMCE Toolbar Button