handbook/commands/post/block/get.md

wp post block get

Gets a single block by index.

Retrieves the full structure of a block at the specified position.

OPTIONS

See the argument syntax reference for a detailed explanation of the syntax conventions used.

<id>

The ID of the post.

<index>

The block index (0-indexed).

[--raw]

Include innerHTML in output.

[--format=<format>]

Render output in a particular format. --- default: json options:

• json
• yaml ---

EXAMPLES

# Get the first block in a post.
$ wp post block get 123 0
{
    "blockName": "core/paragraph",
    "attrs": {},
    "innerBlocks": []
}

# Get the third block (index 2) with attributes.
$ wp post block get 123 2
{
    "blockName": "core/heading",
    "attrs": {
        "level": 2
    },
    "innerBlocks": []
}

# Get block as YAML format.
$ wp post block get 123 1 --format=yaml
blockName: core/image
attrs:
  id: 456
  sizeSlug: large
innerBlocks: []

# Get block with raw HTML content included.
$ wp post block get 123 0 --raw
{
    "blockName": "core/paragraph",
    "attrs": {},
    "innerBlocks": [],
    "innerHTML": "<p>Hello World</p>",
    "innerContent": ["<p>Hello World</p>"]
}

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.