WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp block synced-pattern create

wp block synced-pattern create

Creates a synced pattern.

In this article

Back to top

GitHub
View Open Issues (0) View Closed Issues (0) Create New Issue

Options

See the argument syntax reference for a detailed explanation of the syntax conventions used.
[--title=<title>]
The pattern title.
[--slug=<slug>]
The pattern slug. Default: sanitized title.
[--content=<content>]
The block content.
[--sync-status=<status>]
Sync status.
—
default: synced
options:
– synced
– unsynced
—
[--status=<status>]
Post status.
—
default: publish
—
[<file>]
Read content from file. Pass ‘-‘ for STDIN.
[--porcelain]
Output only the new pattern ID.

Examples

# Create a synced pattern from content
$ wp block synced-pattern create --title="My Hero" --content='&lt;!-- wp:paragraph --&gt;&lt;p&gt;Hello&lt;/p&gt;&lt;!-- /wp:paragraph --&gt;'

# Create from file
$ wp block synced-pattern create --title="Header" header.html

# Create an unsynced pattern
$ wp block synced-pattern create --title="Footer" --sync-status=unsynced footer.html

# Create from STDIN
$ cat content.html | wp block synced-pattern create --title="From STDIN" -

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”).
--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.

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.