Download the PHP package 10up/wpinstructions without Composer
On this page you can find all versions of the php package 10up/wpinstructions. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download 10up/wpinstructions
More information about 10up/wpinstructions
Files in 10up/wpinstructions
Package wpinstructions
Short Description Run human-readable WordPress commands
License MIT
Informations about the package wpinstructions
WP Instructions
WP Instructions lets you execute WordPress actions in human-readable format e.g. installing WordPress, activating plugins, etc. WP Instruction files can be provided to developers to ease local development setup and improve environment consistency.
[!CAUTION] As of 12 April 2024, this project is archived and no longer being actively maintained.
Requirements
- PHP 7.2+
Install
Install WP Instructions with Composer like so:
Usage
Instructions should be saved in a file named WPInstructions
. Here is an example of an instructions file:
You can execute the instruction file via the command line like so:
Every instructions contains an action
and a list of options
. In the instructions file above, install wordpress
is the action for the first command where url
is an option. Each instruction supports different options.
Supported Instructions
install wordpress
Options: [version] [site title] [site url] [home url] [admin email] [admin user] [admin password] [install type=(multisite|single)] [path=(path to WP directory)]
Installs WordPress. When using this instruction, you will need to pass the following parameters in via the command line: --config_db_host
, --config_db_name
, --config_db_user
, --config_db_pass
. For example:
install theme
Options: [theme name=(theme slug)] [theme version] [theme url] [theme status=(enabled|disabled)
Installs a WordPress theme. theme url
should be used for installing a theme via zip or git. theme name
should match the theme slug.
install plugin
Options: [plugin name=(plugin slug)] [plugin version] [plugin url] [plugin status=(active|network active|inactive)
Installs a WordPress plugin. plugin url
should be used for installing a plugin via zip or git. plugin name
should match the plugin slug.
add site
Options: [site title] [site url] [home url] [admin email] [admin user] [admin password]
Add a site to a multisite instance. site_url
and home_url
are required as options.
activate plugin
Options: *[plugin name=(plugin slug)] [active type=(network|single)]
Activate a plugin.
enable theme
Options: *[theme name=(theme slug)]
Enable a theme.
Examples
See examples in EXAMPLES.md.
Support Level
Archived: This project is no longer maintained by 10up. We are no longer responding to Issues or Pull Requests unless they relate to security concerns. We encourage interested developers to fork this project and make it their own!
Like what you see?
All versions of wpinstructions with dependencies
php Version >=7.2
rmccue/requests Version ^1.7
10up/wpsnapshots Version dev-master
symfony/process Version ^4.2