Skip to main content

10up Gutenberg Training

Overview

The purpose of this project is to help you build and customize (Gutenberg) blocks. This training applies to all engineering disciplines at 10up.

Training Prerequisites

  • Basic understanding of WordPress including how themes are structured.
  • Understanding of JavaScript fundamentals and ES6+ concepts.
  • Basic understanding of React components.

For resources on learning JavaScript and React.js, look through this internal document.

Project Setup

For this training, we recommend the usage of 10up-docker for the local environment. To get everything setup on your computer follow these steps here:

  1. Create a local WordPress installation with the domain gutenberg-training.test
10updocker create gutenberg-training
  1. Clone the gutenberg-lessons repository into the wordpress directory replacing the wp-content folder
cd gutenberg-training-test/wordpress && rm -rf wp-content && git clone [email protected]:10up/gutenberg-lessons.git wp-content
  1. Install the dependencies and build the assets
cd npm install && npm run build
  1. Activate the tenup-theme in WordPress
10updocker wp theme activate tenup-theme

You can now navigate to the editor of your WordPress installation and see the Example Block with the Completed Examples show up in the Block Picker.

caution

The tenup-theme build system requires node version 16 in order to build successfully. If you have nvm installed it should auto-detect which version to use.

Also, make sure that you are running your npm commands from the wp-content folder. Not from the Theme folder.

If you want to have your code automatically compile again and even hot reload directly in the editor when you make any changes you can start the watch mode. Before that works you need to enable the WordPress Debug mode by setting WP_DEBUG and SCRIPT_DEBUG in your wp-config.php file to true.

Once that is done you can start the watch mode by running:

npm run watch

The block setup in 10up's wp-scaffold

The 10up wp-scaffold theme includes a few helpers that make working with custom blocks easier. For example the block registration happens automatically when you create a new folder with a block.json file in it inside the includes/blocks/ directory of the theme.

The registration also takes any block assets that are defined in the block.json file (editorScript, viewScript, script, style, and editorStyle) and automatically adds them to the list of entrypoints that get transpiled using 10up-toolkit.

If there is a markup.php file located inside the same directory as the block.json, it will automatically get added as the render_callback and therefore provide a quick way to build dynamic blocks.

Lessons

Support

If you run into issues with this training project, feel free to reach out in Slack to #10up-gutenberg. We also welcome bug reports, suggestions and contributions via the Issues & Discussions tab on GitHub.