The key to creating a Gutenberg block is to understand its basic structure and correctly connect front and back end resources. 1. Prepare the development environment: install local WordPress, Node.js and @wordpress/scripts; 2. Use PHP to register blocks and define the editing and display logic of blocks in JavaScript; 3. Build JS files through npm to make changes take effect; 4. Check whether the path and icons are correct when encountering problems or use real-time listening to build to avoid repeated manual compilation. Following these steps, a simple Gutenberg block can be implemented step by step.
Creating a simple Gutenberg block is not really difficult, especially if you are already familiar with the basic development process of WordPress. Gutenberg is the new editor of WordPress, which organizes content through "blocks", each block is an independent content unit. If you want to customize your own block, you can start from the most basic one and implement it step by step.
Here are some practical steps and suggestions to help you get started quickly.
Preparation: Set up a development environment
Before you start writing code, make sure you have a WordPress environment suitable for development. You can use local development tools such as Local or XAMPP to build a test site.
- Install the latest version of WordPress
- Install Node.js and npm (for building JavaScript files)
- Install the
@wordpress/scripts
package, which is the official recommended script tool set
You can install the necessary dependencies through the following command:
npm install --save-dev @wordpress/scripts
Then, create a directory in your theme or plugin to store block code, such as /blocks/my-first-block/
.
Create basic structure: register blocks and edit components
A Gutenberg block is usually composed of two parts: PHP is used to register blocks , and JavaScript is used to define the appearance and behavior of blocks .
PHP section (registration block)
Add the following code to your theme functions.php
file, or load it in the plugin:
function register_my_first_block() { wp_register_script( 'my-first-block', get_template_directory_uri() . '/blocks/my-first-block/build/index.js', array( 'wp-blocks', 'wp-element' ) ); register_block_type( 'my-plugin/first-block', array( 'editor_script' => 'my-first-block', ) ); } add_action( 'init', 'register_my_first_block' );
This code tells WordPress where the JS script for this block is and registers a new block type.
JavaScript section (definition block)
Write the following content in /blocks/my-first-block/src/index.js
:
const { registerBlockType } = wp.blocks; const { RichText } = wp.editor; registerBlockType( 'my-plugin/first-block', { title: 'My first block', icon: 'smiley', category: 'common', edit: () => { Return ( <RichText tagName="p" placeholder="Enter some text..." /> ); }, save: () => { return <RichText.Content tagName="p" value="This is a static text" />; }, } );
This way you create a block that you can see in the editor.
Build and run: Compile JS files with npm
The Gutenberg block requires JavaScript to be compiled into a format that the browser can recognize. You can use the scripting tools provided by WordPress to automate this process.
Create a package.json
file in the project root directory and add the following configuration:
{ "name": "my-first-block", "version": "1.0.0", "scripts": { "build": "wp-scripts build ./blocks/my-first-block/src/index.js" } }
Then run:
npm run build
After each time you modify the JS file, you must re-run the build
command to make the changes take effect.
Tips and FAQs
The icon cannot be displayed? You can use the icon name in WordPress Dashicons .
Blocks are not displayed? Check whether JS compiles successfully and whether the PHP registration path is correct.
Don't want to compile manually every time? You can add
--watch
parameter to listen to file changes in real time and automatically build:npx wp-scripts build ./blocks/my-first-block/src/index.js --watch
Basically that's it. The key to creating a Gutenberg block from scratch is to understand the basic structure of the block and how to connect front and back end resources. Although it seems a bit complicated, you can quickly grasp it by just taking it step by step.
The above is the detailed content of How to create a simple Gutenberg block. For more information, please follow other related articles on the PHP Chinese website!

Hot AI Tools

Undress AI Tool
Undress images for free

Undresser.AI Undress
AI-powered app for creating realistic nude photos

AI Clothes Remover
Online AI tool for removing clothes from photos.

Clothoff.io
AI clothes remover

Video Face Swap
Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Article

Hot Tools

Notepad++7.3.1
Easy-to-use and free code editor

SublimeText3 Chinese version
Chinese version, very easy to use

Zend Studio 13.0.1
Powerful PHP integrated development environment

Dreamweaver CS6
Visual web development tools

SublimeText3 Mac version
God-level code editing software (SublimeText3)

Hot Topics

To roll back the WordPress version, you can use the plug-in or manually replace the core file and disable automatic updates. 1. Use WPDowngrade and other plug-ins to enter the target version number to automatically download and replace; 2. Manually download the old version of WordPress and replace wp-includes, wp-admin and other files through FTP, but retain wp-config.php and wp-content; 3. Add code in wp-config.php or use filters to disable core automatic updates to prevent further upgrades. Be sure to back up the website and database before operation to ensure safety and reliability. It is recommended to keep the latest version for security and functional support in the long term.

The steps to create a custom shortcode in WordPress are as follows: 1. Write a PHP function through functions.php file or custom plug-in; 2. Use add_shortcode() to bind the function to the shortcode tag; 3. Process parameters in the function and return the output content. For example, when creating button shortcodes, you can define color and link parameters for flexible configuration. When using it, you can insert a tag like [buttoncolor="red"url="https://example.com"] in the editor, and you can use do_shortcode() to model it

The main reasons why WordPress causes the surge in server CPU usage include plug-in problems, inefficient database query, poor quality of theme code, or surge in traffic. 1. First, confirm whether it is a high load caused by WordPress through top, htop or control panel tools; 2. Enter troubleshooting mode to gradually enable plug-ins to troubleshoot performance bottlenecks, use QueryMonitor to analyze the plug-in execution and delete or replace inefficient plug-ins; 3. Install cache plug-ins, clean up redundant data, analyze slow query logs to optimize the database; 4. Check whether the topic has problems such as overloading content, complex queries, or lack of caching mechanisms. It is recommended to use standard topic tests to compare and optimize the code logic. Follow the above steps to check and solve the location and solve the problem one by one.

Methods to optimize WordPress sites that do not rely on plug-ins include: 1. Use lightweight themes, such as Astra or GeneratePress, to avoid pile-up themes; 2. Manually compress and merge CSS and JS files to reduce HTTP requests; 3. Optimize images before uploading, use WebP format and control file size; 4. Configure.htaccess to enable browser cache, and connect to CDN to improve static resource loading speed; 5. Limit article revisions and regularly clean database redundant data.

Miniving JavaScript files can improve WordPress website loading speed by removing blanks, comments, and useless code. 1. Use cache plug-ins that support merge compression, such as W3TotalCache, enable and select compression mode in the "Minify" option; 2. Use a dedicated compression plug-in such as FastVelocityMinify to provide more granular control; 3. Manually compress JS files and upload them through FTP, suitable for users familiar with development tools. Note that some themes or plug-in scripts may conflict with the compression function, and you need to thoroughly test the website functions after activation.

TransientsAPI is a built-in tool in WordPress for temporarily storing automatic expiration data. Its core functions are set_transient, get_transient and delete_transient. Compared with OptionsAPI, transients supports setting time of survival (TTL), which is suitable for scenarios such as cache API request results and complex computing data. When using it, you need to pay attention to the uniqueness of key naming and namespace, cache "lazy deletion" mechanism, and the issue that may not last in the object cache environment. Typical application scenarios include reducing external request frequency, controlling code execution rhythm, and improving page loading performance.

Object cache assists persistent storage, suitable for high access and low updates, tolerating short-term lost data. 1. Data suitable for "persistence" in cache includes user configuration, popular product information, etc., which can be restored from the database but can be accelerated by using cache. 2. Select a cache backend that supports persistence such as Redis, enable RDB or AOF mode, and configure a reasonable expiration policy, but it cannot replace the main database. 3. Set long TTL or never expired keys, adopt clear key name structure such as user:1001:profile, and update the cache synchronously when modifying data. 4. It can combine local and distributed caches to store small data locally and big data Redis to store big data and use it for recovery after restart, while paying attention to consistency and resource usage issues.

When developing Gutenberg blocks, the correct method of enqueue assets includes: 1. Use register_block_type to specify the paths of editor_script, editor_style and style; 2. Register resources through wp_register_script and wp_register_style in functions.php or plug-in, and set the correct dependencies and versions; 3. Configure the build tool to output the appropriate module format and ensure that the path is consistent; 4. Control the loading logic of the front-end style through add_theme_support or enqueue_block_assets to ensure that the loading logic of the front-end style is ensured.
