Block Editor Handbook Edit
Hi! 👋 Welcome to the Block Editor Handbook.
The Block editor is a modern and up-to-date paradigm for WordPress site building and publishing. It uses a modular system of Blocks to compose and format content, and is designed to create rich and flexible layouts for websites and digital products.
The editor consists of several primary elements, as shown in the following figure:
The elements highlighted in the figure are:
- Inserter: A panel for inserting blocks into the content canvas
- Content canvas: The content editor, which holds content created with blocks
- Settings sidebar: A sidebar panel for configuring a block’s settings (among other things)
Through the Block editor, you create content modularly using Blocks. There are a number of core blocks ready to be used, and you can also create your own custom block.
A Block is a discrete element such as a Paragraph, Heading, Media element, or Embed. Each block is treated as a separate element with individual editing and format controls. When all these components are pieced together, they make up the content that is then stored in the WordPress database.
The Block Editor is the result of the work done on the Gutenberg project which is aimed to revolutionize the WordPress editing experience.
Besides offering an enhanced editing experience through visual content creation tools, the Block Editor is also a powerful developer platform with a rich feature set of APIs that allow it to be manipulated and extended in a multitude of different ways.
Navigating this handbook
This handbook is focused on block development and is divided into five sections, each serving a different purpose.
For those just starting out with block development this is where you can get set up with a development environment and learn the fundamentals of block development.
This section is the heart of the handbook and is where you can get down to the nitty-gritty and look up the details of the particular API that you’re working with or need information on. Among other things, the Block API Reference covers most of what you will want to do with a block, and each component and package is also documented here. Components are also documented via Storybook.
This section enables you to go deeper and reinforce your practical knowledge with a theoretical understanding of the Architecture of the block editor. Its Glossary of terms and FAQs should answer any outstanding questions you may have.
Gutenberg is open source software and anyone is welcome to contribute to the project. This section details how to contribute and can help you choose in which way you want to contribute, whether that be with code, with design, with documentation, or in some other way.
This handbook should be considered the canonical resource for all things related to block development. However there are other resources that can help you.
- WordPress Developer Blog – An ever-growing resource of technical articles covering specific topics related to block development and a wide variety of use cases. The blog is also an excellent way to keep up with the latest developments in WordPress.
- Learn WordPress – The WordPress hub for learning resources where you can find courses like Introduction to Block Development: Build your first custom block, Converting a Shortcode to a Block or Using the WordPress Data Layer
- WordPress.tv – A hub of WordPress-related videos (from talks at WordCamps to recordings of online workshops) curated and moderated by the WordPress.org community. You’re sure to find something to aid your learning about block development or the block-editor here.
- Gutenberg repository – Development of the block editor project is carried out in this GitHub repository. It contains the code of interesting packages such as
block-library(core blocks) or
components(common UI elements). The gutenberg-examples repository is another useful reference.
Are you in the right place?
This handbook is targeted at those seeking to develop for the block editor, but several other handbooks exist for WordPress developers under developer.wordpress.org:
- /themes – Theme Handbook
- /plugins – Plugin Handbook
- /apis – Common APIs Handbook
- /advanced-administration – WP Advanced Administration Handbook
- /rest-api – REST API Handbook
- /coding-standards – Best practices for WordPress developers