Description
The block editor was introduced in core WordPress with version 5.0 but the Gutenberg project will ultimately impact the entire publishing experience including customization (the next focus area). This beta plugin allows you to test bleeding-edge features around editing and customization projects before they land in future WordPress releases.
Discover more about the project.
Editing focus
The editor will create a new page- and post-building experience that makes writing rich posts effortless, and has “blocks” to make it easy what today might take shortcodes, custom HTML, or “mystery meat” embed discovery. — Matt Mullenweg
One thing that sets WordPress apart from other systems is that it allows you to create as rich a post layout as you can imagine — but only if you know HTML and CSS and build your own custom theme. By thinking of the editor as a tool to let you write rich posts and create beautiful layouts, we can transform WordPress into something users love WordPress, as opposed something they pick it because it’s what everyone else uses.
Gutenberg looks at the editor as more than a content field, revisiting a layout that has been largely unchanged for almost a decade.This allows us to holistically design a modern editing experience and build a foundation for things to come.
Here’s why we’re looking at the whole editing screen, as opposed to just the content field:
- The block unifies multiple interfaces. If we add that on top of the existing interface, it would add complexity, as opposed to remove it.
- By revisiting the interface, we can modernize the writing, editing, and publishing experience, with usability and simplicity in mind, benefitting both new and casual users.
- When singular block interface takes center stage, it demonstrates a clear path forward for developers to create premium blocks, superior to both shortcodes and widgets.
- Considering the whole interface lays a solid foundation for the next focus, full site customization.
- Looking at the full editor screen also gives us the opportunity to drastically modernize the foundation, and take steps towards a more fluid and JavaScript powered future that fully leverages the WordPress REST API.
Blocks
Blocks are the unifying evolution of what is now covered, in different ways, by shortcodes, embeds, widgets, post formats, custom post types, theme options, meta-boxes, and other formatting elements. They embrace the breadth of functionality WordPress is capable of, with the clarity of a consistent user experience.
Imagine a custom “employee” block that a client can drag to an About page to automatically display a picture, name, and bio. A whole universe of plugins that all extend WordPress in the same way. Simplified menus and widgets. Users who can instantly understand and use WordPress — and 90% of plugins. This will allow you to easily compose beautiful posts like this example.
Check out the FAQ for answers to the most common questions about the project.
Compatibility
Posts are backwards compatible, and shortcodes will still work. We are continuously exploring how highly-tailored metaboxes can be accommodated, and are looking at solutions ranging from a plugin to disable Gutenberg to automatically detecting whether to load Gutenberg or not. While we want to make sure the new editing experience from writing to publishing is user-friendly, we’re committed to finding a good solution for highly-tailored existing sites.
The stages of Gutenberg
Gutenberg has three planned stages. The first, aimed for inclusion in WordPress 5.0, focuses on the post editing experience and the implementation of blocks. This initial phase focuses on a content-first approach. The use of blocks, as detailed above, allows you to focus on how your content will look without the distraction of other configuration options. This ultimately will help all users present their content in a way that is engaging, direct, and visual.
These foundational elements will pave the way for stages two and three, planned for the next year, to go beyond the post into page templates and ultimately, full site customization.
Gutenberg is a big change, and there will be ways to ensure that existing functionality (like shortcodes and meta-boxes) continue to work while allowing developers the time and paths to transition effectively. Ultimately, it will open new opportunities for plugin and theme developers to better serve users through a more engaging and visual experience that takes advantage of a toolset supported by core.
Contributors
Gutenberg is built by many contributors and volunteers. Please see the full list in CONTRIBUTORS.md.
Blocks
This plugin provides 16 blocks.
- core/block
- Gutenberg
- core/social-link-
- Gutenberg
- core/post-content
- Gutenberg
- core/latest-posts
- Gutenberg
- core/shortcode
- Gutenberg
- core/legacy-widget
- Gutenberg
- core/tag-cloud
- Gutenberg
- core/categories
- Gutenberg
- core/post-title
- Gutenberg
- core/latest-comments
- Gutenberg
- core/site-title
- Gutenberg
- core/navigation
- Gutenberg
- core/calendar
- Gutenberg
- core/archives
- Gutenberg
- core/search
- Gutenberg
- core/rss
- Gutenberg
FAQ
- How can I send feedback or get help with a bug?
-
We’d love to hear your bug reports, feature suggestions and any other feedback! Please head over to the GitHub issues page to search for existing issues or open a new one. While we’ll try to triage issues reported here on the plugin forum, you’ll get a faster response (and reduce duplication of effort) by keeping everything centralized in the GitHub repository.
- How can I contribute?
-
We’re calling this editor project “Gutenberg” because it’s a big undertaking. We are working on it every day in GitHub, and we’d love your help building it.You’re also welcome to give feedback, the easiest is to join us in our Slack channel,
#core-editor
.See also CONTRIBUTING.md.
- Where can I read more about Gutenberg?
-
- Gutenberg, or the Ship of Theseus, with examples of what Gutenberg might do in the future
- Editor Technical Overview
- Design Principles and block design best practices
- WP Post Grammar Parser
- Development updates on make.wordpress.org
- Documentation: Creating Blocks, Reference, and Guidelines
- Additional frequently asked questions
Reviews
Contributors & Developers
“Gutenberg” is open source software. The following people have contributed to this plugin.
Contributors“Gutenberg” has been translated into 46 locales. Thank you to the translators for their contributions.
Translate “Gutenberg” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Changelog
Features
- Add a new Navigation block (previously available as an experiment)
- Highlight menu items without defined URL.
- Prevent error in Firefox when removing the block.
- Remove background color from the Navigation block and rely on the Group block.
- Remove the background shadow for the submenus dropdown.
- Rename “Navigation Menu Item” block to “Link”.
- Remove unnecessary color attributes.
- Allow addition CSS classes.
- Drop the “menu” suffix from the block name.
- Escape special characters in the frontend.
- Remove from experimental features.
- Add style variations.
Enhancements
- Use gradient classnames instead of inline styles for the Cover block.
- Inserter: Add keyboard shortcut styling to “/” in the default tip.
- Restore the caret position properly on undo.
- Add keywords to improve the discoverability of the Audio block.
- Show video preview on Cover block inspector panel.
Bug Fixes
- Fix hidden nested images in the content column.
- Fix double border issue in the keyboard shortcuts modal.
- Fix off-centered publish button.
- Fix error when isRTL config is not provided in the block editor settings.
- Fix full width Table block mobile regression.
- A11y: Add a screen reader text label for the Search block.
- Fix text patterns undo after mouse move.
- Fix block drag and drop for the contributor role.
- Update the link when switching the image used in the Image block.
- Fix php error triggered when gutenberg_register_packages_scripts is run more than once.
- Fix special characters escaping for the post title.
- Fix JavaScript errors triggered when selectors are called before the editor being initialized.
- Fix BaseControl component label when no id is passed.
- Preserve whitespace when converting blocks Preformatted and Paragraph blocks.
- Fix multiple paste issues creating unnecessary empty spaces.
New APIs
- Add a new Card component to @wordpress/components.
- Add label support for the URLInput component.
- Support the isMatch option for the shorcode transforms.
Experiments
- Block Content areas:
- Add Post Title and Post Content blocks.
- Add template parts CPT and the theme resolution logic.
- Widgets Screen:
- Refactor the legacy widgets block to support all blocks.
- Fix widget areas margins.
- Add isRTL setting.
- APIs
- useColors hook: Enhance the contrast checking API and provide access to the color value.
- Introduce createInterpolateElement to allow translation of complex strings with HTML content.
- A11y: Refactor the accessibility behavior of the Toolbar component.
- Social Links:
- Capitalize LinkedIn and GitHub properly.
- Fix frontend styling.
Documentation
- Add a Backward Compatibility policy document.
- Clarify the npm packages release documentation.
- Add documentation for the @wordpress/env wp-env.json config file.
- Typos and tweaks: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20.
Various
- Refactor the RichText component: Remove the inner Editable component.
- Integrate the Gutenberg Playground into Storybook.
- Increase WordPress minimum supported by the plugin to 5.2.0.
- Refactor the Paragraph block edit function as a functional component.
- Refactor the Cover block edit function as a functional component.
- Add new components to Storybook.
- RadioControl component.
- TabPanel component.
- Popover component.
- BaseControl component.
- Tip component.
- Include WordPress eslint plugin in React eslint ruleset in @wordpress/eslint-plugin.
- Block PRs on mobile unit test failures in Travis.
- Polish the PostSchedule popover styling.
- Fix the API documentation generation tool when spaces are used in folder names.
- Add missing @babel/runtime dependency to the @wordpress/jest-puppeteer-axe.
- Refactor the Layout component to separate the UI from the content.
- Align Dropdown and DropdownMenu components styling.
- Remove max-width style from the Image block.
- Remove the CollegeHumor embed block.
- Add unit tests:
- Ensure consecutive edits to the same attribute are considered persistent.
- Test the core-data undo reducer.