WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp post block insert

wp post block insert

Inserts a block into a post at a specified position.

In this article

View as Markdown

Back to top

GitHub
View Open Issues (0) View Closed Issues (0) Create New Issue
Note: This command is not part of a stable WP-CLI release yet. To use it now, switch to the nightly build with wp cli update --nightly. If you installed the command as a separate package, updating that package may be enough.
Adds a new block to the post content. By default, the block is appended to the end of the post.

Options

See the argument syntax reference for a detailed explanation of the syntax conventions used.
<id>
The ID of the post to modify.
<block-name>
The block type name (e.g., ‘core/paragraph’).
[–content=<content>]
The inner content/HTML for the block.
[–attrs=<attrs>]
Block attributes as JSON.
[–position=<position>]
Position to insert the block (0-indexed). Use ‘start’ or ‘end’. — default: end —
[–porcelain]
Output just the post ID.

Examples

# Insert a paragraph block at the end of the post.
$ wp post block insert 123 core/paragraph --content="Hello World"
Success: Inserted block into post 123.

# Insert a level-2 heading at the start.
$ wp post block insert 123 core/heading --content="My Title" --attrs='{"level":2}' --position=start
Success: Inserted block into post 123.

# Insert an image block at position 2.
$ wp post block insert 123 core/image --attrs='{"id":456,"url":"https://example.com/image.jpg"}' --position=2

# Insert a separator block.
$ wp post block insert 123 core/separator

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.