Installation

To use WordPlate, you need to have PHP 7.1.3+ installed on your machine. You’ll also optionally need Node.js and NPM installed if you want to use Laravel Mix to compile your CSS and Javascript.

Are you a visual learner? WordPlate provides a free, thorough introduction to WordPlate for newcomers to the framework. It's a great place to start your journey.

Make sure your server meets the following requirements:

Install WordPlate by issuing the Composer create-project command in your terminal:

$ composer create-project wordplate/wordplate

Laravel Valet

If you want to use Laravel Valet with WordPlate, please see our local valet driver repository.

Configuration

The first thing you should do after installing WordPlate is to add WordPress salts to your .env environment file.

Typically, these strings should be 64 characters long. The strings can be set in the .env environment file. If you have not renamed the .env.example file to .env, you may do that now. If the WordPress salts is not set, your user sessions and other encrypted data will not be secure!

Please visit WordPlate’s salt page and copy the WordPress salts to your environment file.

If you’re using WP-CLI and want to generate your salt keys on the CLI. Please see the WP-CLI Dotenv helper command by Evan Mattson.

WordPlate ships with a lot of default configuration for setting up new WordPress sites. Please see the source code if you want to see what environment variables that exists in the framework.

For example; if you want to force a custom address to your website you may add the environment variables WP_HOME and WP_SITEURL to the .env file.

WP_HOME=https://example.com
WP_SITEURL=https://example.com

Public Directory

After installing WordPlate, you should configure your web server’s document / web root to be the public directory. The index.php in this directory serves as the front controller for all HTTP requests entering your application.

WordPress

WordPlate supports WordPress 5.+ and comes with the latest version out of the box. If you want to specify an exact version of WordPress you may add it to your composer.json file.

"require": {
  "johnpbloch/wordpress": "5.0.1"
}

This way you can lock the WordPress version number to the one you’re working with. This could come in handy if you’re opening your project six months from now and WordPress has released a new version with breaking changes.

Theming

Building themes with WordPlate works like any other WordPress environment. All available WordPress classes and helper functions are available in WordPlate as well.

Please visit the official WordPress documentation to read more about theming in WordPress.