Installation

Create your local WordPress installation

First of all, you should prepare the development environment. I may suggest the following:

• Vagrant
• Valet

To start developing a WP Bones plugin, you must have a copy of WordPress files. You can download the latest WordPress release from wordpress.org.

Create your plugin

To create your WP Bones plugin, you can use one of our ready-made boilerplate templates available on GitHub. You can choose one of the following:

• WPKirk Boilerplate - this is the base template, without examples inside, recommended for experienced users.
• WPKirk Complete Demo - this is the template with several examples inside, recommended for beginners.

For both, you can choose to create your repository on GitHub using the available templates or clone the repository directly to your computer.

By using the GitHub template

On GitHub, you can create a new repository using the WPKirk Boilerplate by clicking on the “Use this template” button on the repository page.

Clone from GitHub

You may also clone the repository using either the Git command line or the GitHub for Mac application. Change the directory to the wp-content/plugins folder of your local WordPress installation.

cd wp-content/plugins

The complete demo

git clone -b main https://github.com/wpbones/WPKirk.git <your plugin folder>

The simple boilerplate

git clone -b main https://github.com/wpbones/WPKirk-Boilerplate.git <your plugin folder>

rm -rf .git

Install the necessary packages to compile the assets

From within your plugin folder, run:

npm install

pnpm install

yarn install

bun install

Take a look at the Assets section to learn more.

Check the installation

Next, from inside your plugin folder, try to run:

php bones

You should see:

Install

Finally, install the WP Bones Framework inside the plugin:

php bones install

👏 Awesome! You are ready to start developing your first WP Bones plugin.