creating-blocks

Templates and guidelines for creating new WordPress blocks from scratch — load this before generating block files

npx skills add https://github.com/automattic/studio --skill creating-blocks

When to use me

Use this skill when creating a new block from scratch. Do not use this skill when modifying an existing block.

Generating Blocks Instructions

  • Always use the current folder to generate the block
  • Always remove space before the PHP opening tag, nor leave more than one empty new line at the end of any file
  • Always use block props to make sure the block is selectable in the canvas
  • Always use the lowercase for block name slugs
  • Never close the last PHP opening tag, you always leave it open
  • Never suggest or generate code outside the specification, such as REST controllers, PHP classes, or other code that is not part of a standard WordPress block
  • Prefer building blocks that have the same behaviour on the frontend and the backend, unless the user asks for a block that is specifically different on the frontend
  • Do not opt for placeholders in the editor
  • Be proactive in adding inspector or block toolbar controls that can make the block more interactive and customizable
  • Never redeclare functions in PHP and always guard with function_exists
  • Do not create additional markdown files with extense documentations or installation instructions
  • Make sure the block is registered correctly so that it renders on the front end
  • Use the InnerBlocks component from @wordpress/block-editor as much as possible.

Interactive Blocks

When the block requires frontend interactivity (clicks, toggles, accordions, modals, carousels, counters, tabs, search filters):

  • The block MUST also be dynamic (uses render.php, no save.js)
  • Use plain JavaScript with standard DOM APIs (querySelector, addEventListener, classList, etc.) in view.js — never use the WordPress Interactivity API
  • In block.json: use "viewScript": "file:./view.js" (not viewScriptModule)
  • In render.php: use standard HTML attributes and CSS classes that your JavaScript targets
  • Use data-* attributes on the block wrapper to pass server-side values to JavaScript

Reference Files

Before generating block files, read the relevant references from the references/ directory next to this skill file.

  • references/artefact-templates.md — REQUIRED: read this FIRST before generating any block files. Contains exact file templates with correct paths, asset references, and build pipeline details. You MUST follow these templates exactly.
  • references/file-templates.md — additional guidelines for each block file type
  • references/inner-blocks.md — read this if the block uses InnerBlocks or child blocks
  • references/dynamic-vs-static.md — read this if you need to decide between a dynamic, static, or interactive rendering approach
  • references/interactivity-api.md — read this when creating an interactive block that needs frontend JavaScript

Lebih banyak skill dari automattic

wp-phpstan
automattic
Gunakan saat mengonfigurasi, menjalankan, atau memperbaiki analisis statis PHPStan di proyek WordPress (plugin/tema/situs): pengaturan phpstan.neon, baseline,…
official
wp-playground
automattic
Gunakan untuk alur kerja WordPress Playground: instance WP cepat yang dapat dibuang di browser atau secara lokal melalui @wp-playground/cli (server, run-blueprint, build-snapshot),…
official
wp-plugin-development
automattic
Gunakan saat mengembangkan plugin WordPress: arsitektur dan hooks, aktivasi/deaktivasi/pencopotan, antarmuka admin dan API Pengaturan, penyimpanan data, cron/tugas, keamanan…
official
wp-project-triage
automattic
Gunakan saat Anda memerlukan inspeksi deterministik terhadap repositori WordPress (plugin/tema/tema blok/WP inti/Gutenberg/situs penuh) termasuk perkakas/pengujian/versi…
official
wp-rest-api
automattic
Gunakan saat membangun, memperluas, atau men-debug endpoint/rute REST API WordPress: register_rest_route, kelas WP_REST_Controller/controller, skema/argumen…
official
wp-wpcli-and-ops
automattic
Gunakan saat bekerja dengan WP-CLI (wp) untuk operasi WordPress: pencarian-pengganti yang aman, ekspor/impor db, manajemen plugin/tema/pengguna/konten, cron, pembersihan cache,…
official
wpds
automattic
Gunakan saat membangun antarmuka pengguna yang memanfaatkan WordPress Design System (WPDS) dan komponen, token, pola, dll.
official
woocommerce-finalize
automattic
Audit kesehatan kode dan ketertelusuran pra-rilis untuk plugin WooCommerce. Dijalankan setelah tinjauan kode -- berfokus pada kode mati, duplikasi, kompleksitas struktural, dan…
official