👋 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 many 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, 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 aims 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 many different ways.
This handbook is focused on block development and is divided into five sections, each serving a different purpose.
-
Getting Started - 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. Its Quick Start Guide and Tutorial: Build your first block are probably the best places to start learning block development.
-
How-to Guides - Here, you can build on what you learned in the Getting Started section and learn how to solve particular problems you might encounter. You can also get tutorials and example code that you can reuse for projects such as working with WordPress’ data or Curating the Editor Experience.
-
Reference Guides - 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 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.
-
Explanations - This section enables you to go deeper and reinforce your practical knowledge with a theoretical understanding of the Architecture of the block editor.
-
Contributor Guide - 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 with code, design, 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) orcomponents(common UI elements). The block-development-examples repository is another useful reference. - End User Documentation - This documentation site is targeted to the end user (not developers), where you can also find documentation about the Block Editor and working with blocks.
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