Scaffold
Scaffold Post-Type
wp scaffold post-type
Generates PHP code for registering a custom post type.
OPTIONS
<slug> : The internal name of the post type.
[--label=<label>] : The text used to translate the update messages.
[--textdomain=<textdomain>] : The textdomain to use for the labels.
[--dashicon=<dashicon>] : The dashicon to use in the menu.
[--theme] : Create a file in the active theme directory, instead of sending to STDOUT. Specify a theme with --theme=<theme>
to have the file placed in that theme.
[--plugin=<plugin>] : Create a file in the given plugin's directory, instead of sending to STDOUT.
[--raw] : Just generate the register_post_type()
call and nothing else.
[--force] : Overwrite files that already exist.
EXAMPLES
# Generate a 'movie' post type for the 'simple-life' theme
$ wp scaffold post-type movie --label=Movie --theme=simple-life
Success: Created '/var/www/example.com/public_html/wp-content/themes/simple-life/post-types/movie.php'.
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. |