WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp scaffold block

wp scaffold block

Generates PHP, JS and CSS code for registering a Gutenberg block for a plugin or theme.

In this article

Back to top

GitHub
View Open Issues (0) View Closed Issues (31) Create New Issue
Warning: wp scaffold block is deprecated. The official script to generate a block is the @wordpress/create-block package. See the Create a Block tutorial for a complete walk-through.

Options

See the argument syntax reference for a detailed explanation of the syntax conventions used.
<slug>
The internal name of the block.
[–title=<title>]
The display title for your block.
[–dashicon=<dashicon>]
The dashicon to make it easier to identify your block.
[–category=<category>]
The category name to help users browse and discover your block. — default: widgets options: – common – embed – formatting – layout – widgets —
[–theme]
Create files in the active theme directory. Specify a theme with --theme=<theme> to have the file placed in that theme.
[–plugin=<plugin>]
Create files in the given plugin’s directory.
[–force]
Overwrite files that already exist.

Global Parameters

These global parameters have the same behavior across all commands and affect how WP-CLI interacts with WordPress.
Argument Description
--path=<path> Path to the WordPress files.
--url=<url> Pretend request came from given URL. In multisite, this argument is how the target site is specified.
--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>] Perform operation against a remote server over SSH (or a container using scheme of “docker”, “docker-compose”, “docker-compose-run”, “vagrant”).
--ssh-args=<args> Pass additional arguments to SSH (or other tools specified by –ssh scheme).
--http=<http> Perform operation against a remote WordPress installation over HTTP.
--user=<id\|login\|email> Set the WordPress user.
--skip-plugins[=<plugins>] Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded.
--skip-themes[=<themes>] Skip loading all themes, or a comma-separated list of themes.
--skip-packages Skip loading all installed packages.
--require=<path> Load PHP file before running the command (may be used more than once).
--exec=<php-code> Execute PHP code before running the command (may be used more than once).
--context=<context> Load WordPress in a given context.
--[no-]color Whether to colorize the output.
--debug[=<group>] Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help.
--prompt[=<assoc>] Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values.
--quiet Suppress informational messages.
--alias=<name> Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file.
--assume-https Set $_SERVER[‘HTTPS’] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer.

Command documentation is regenerated at every release. To add or update an example, please submit a pull request against the corresponding part of the codebase.