vinkla / wordplate
The WordPlate boilerplate
Installs: 3 568
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2 123
Watchers: 52
Forks: 155
Open Issues: 1
Type:project
Requires
- php: ^8.2
- composer/installers: ^2.3
- roots/bedrock-autoloader: ^1.0.4
- roots/wordpress: ^6.6.2
- roots/wp-password-bcrypt: ^1.2
- symfony/http-foundation: ^7.1
- vinkla/headache: ^3.3
- vlucas/phpdotenv: ^5.6
- wpackagist-plugin/clean-image-filenames: ^1.5
Requires (Dev)
- symfony/var-dumper: ^7.1
- dev-master
- 12.9.2
- 12.9.1
- 12.9.0
- 12.8.5
- 12.8.4
- 12.8.3
- 12.8.2
- 12.8.1
- 12.8.0
- 12.7.6
- 12.7.5
- 12.7.4
- 12.7.3
- 12.7.2
- 12.7.1
- 12.7.0
- 12.6.0
- 12.5.0
- 12.4.5
- 12.4.3
- 12.4.2
- 12.4.1
- 12.4.0
- 12.3.3
- 12.3.2
- 12.3.1
- 12.3.0
- 12.2.0
- 12.0.6
- 12.0.5
- 12.0.4
- 12.0.3
- 12.0.2
- 12.0.1
- 12.0.0
- 11.1.0
- 11.0.0
- 10.0.1
- 10.0.0
- 9.5.2
- 9.5.1
- 9.5.0
- 9.4.1
- 9.4.0
- 9.3.2
- 9.3.1
- 9.3.0
- 9.2.0
- 9.1.0
- 9.0.0
- 8.1.0
- 8.0.0
- 7.1.0
- 7.0.0
- 6.3.1
- 6.3.0
- 6.2.2
- 6.2.1
- 6.2.0
- 6.1.0
- 6.0.0
- 5.3.1
- 5.3.0
- 5.2.2
- 5.2.1
- 5.2.0
- 5.1.0
- 5.0.4
- 5.0.3
- 5.0.2
- 5.0.1
- 5.0.0
- 4.3.0
- 4.2.1
- 4.2.0
- 4.1.3
- 4.1.2
- 4.1.1
- 4.1.0
- 4.0.7
- 4.0.6
- 4.0.5
- 4.0.4
- 4.0.3
- 4.0.2
- 4.0.1
- 4.0.0
- 3.1.1
- 3.1.0
- 3.0.2
- 3.0.1
- 3.0.0
- 2.7.0
- 2.6.0
- 2.5.4
- 2.5.3
- 2.5.2
- 2.5.1
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.0
- 2.1.3
- 2.1.2
- 2.1.1
- 2.1.0
- 2.0.0
- 1.3.0
- 1.2.2
- 1.2.1
- 1.2.0
- 1.1.1
- 1.1.0
- 1.0.0
- dev-dependabot/npm_and_yarn/vite-tw-6.0.5
- dev-dependabot/npm_and_yarn/vite-tw-6.0.4
This package is auto-updated.
Last update: 2024-12-21 13:51:49 UTC
README
WordPlate
WordPlate is a boilerplate for WordPress, built with Composer and designed with sensible defaults.
Features
-
WordPress + Composer = ❤️
WordPress can be installed and updated with ease using Composer. To update WordPress, simply run the command
composer update
. -
Environment Files
Similar to Laravel, WordPlate stores environment variables, such as database credentials, in an
.env
file. -
WordPress Packagist
WordPress Packagist enables the management of WordPress plugins and themes through Composer.
-
Must-use plugins
Don't worry about clients deactivating plugins; must-use plugins are enabled by default.
-
Vite.js
Using Vite, you can rapidly set up and begin building and minifying your CSS and JavaScript.
-
Debugging
Familiar debugging helper functions are integrated such as
dump()
anddd()
. -
Clean UI
Enhance the WordPress dashboard and improves the user experience for clients.
-
Security
We've replaced WordPress' outdated and insecure MD5-based password hashing with modern and secure bcrypt using the
roots/wp-password-bcrypt
package.
Installation
Before using WordPlate, make sure you have PHP 8.2 and MySQL 8.0 installed on your computer. You'll also need to have Composer, a package manager for PHP, installed on your computer.
To install WordPlate, open your terminal and enter the following command:
composer create-project --prefer-dist vinkla/wordplate example-app
After installing WordPlate, you'll need to update the database credentials in the .env
file. This file is located in the root directory of your project. Open the file and update the following lines with your database credentials:
DB_NAME=database DB_USER=username DB_PASSWORD=password
To run your WordPlate application, you may serve it using PHP's built-in web server. Open your terminal and navigate to the public
directory of your project. Then, enter the following command:
php -S 127.0.0.1:8000 -t public/
Finally, open your web browser and visit the following URLs to view your WordPlate application:
http://127.0.0.1:8000/
- Your websitehttp://127.0.0.1:8000/wordpress/wp-admin
- The dashboard
Configuration
Public Directory
After installing WordPlate, you'll need to configure your web server's document or web root to be the public
directory. This is where the main entry point for your application, index.php
, is located.
By setting the public
directory as your web server's document root, you ensure that all HTTP requests are routed through the front controller, which handles the requests and returns the appropriate responses.
This configuration helps to improve the security and performance of your application by preventing direct access to files outside of the public
directory.
Environment Configuration
WordPlate makes it easy to manage different configuration values based on the environment where your application is running. For example, you may need to use a different database locally than you do on your production server.
To accomplish this, WordPlate uses the vlucas/phpdotenv
PHP package. When you install WordPlate, a .env.example
file is included in the root directory of your application. If you installed WordPlate via Composer, this file will automatically be renamed to .env
. Otherwise, you should rename the file manually.
It's important to note that your .env
file should not be committed to your application's source control. This is because each developer or server using your application may require a different environment configuration. Additionally, committing your .env
file to source control would be a security risk in the event that an intruder gains access to your repository, as any sensitive credentials would be exposed.
To learn more about managing environment variables in WordPlate, you can refer to Laravel's documentation on the topic:
Salt Keys
It's important to add salt keys to your environment file. These keys are used to encrypt sensitive data, such as user sessions, and help to ensure the security of your application.
If you don't set the salt keys, your user sessions and other encrypted data may be vulnerable to attacks. To make it easier to generate secure salt keys, we've created a salt key generator that you can use. If you haven't already done so, copy the .env.example
file to a new file named .env
. Then visit the generator and copy the randomly generated keys to your .env
file.
Plugins
WordPress Packagist
WordPlate includes integration with WordPress Packagist, a Composer repository that mirrors the WordPress plugin and theme directories. With this integration, you can install and manage plugins using Composer.
To install a plugin, use wpackagist-plugin
as the vendor name and the plugin slug as the package name. For example, to install the clean-image-filenames
plugin, you would use the following command:
composer require wpackagist-plugin/clean-image-filenames
The installed packages will be located in the public/plugins
directory.
Here's an example of what your composer.json
file might look like:
"require": { "wpackagist-plugin/clean-image-filenames": "^1.5" }
For more information and examples, please visit the WordPress Packagist website.
Must Use Plugins
Must-use plugins (also known as mu-plugins) are a type of WordPress plugin that is installed in a special directory inside the content folder. These plugins are automatically enabled on all sites in the WordPress installation.
To install plugins into the mu-plugins
directory, add the plugin name to the installer-paths
of your composer.json
file:
"installer-paths": { "public/mu-plugins/{$name}": [ "type:wordpress-muplugin", "wpackagist-plugin/clean-image-filenames", ] }
To install the plugin, use wpackagist-plugin
as the vendor name and the plugin slug as the package name:
composer require wpackagist-plugin/clean-image-filenames
The plugin will be installed in the public/mu-plugins
directory.
For more information on the must-use plugin autoloader, please refer to the Bedrock documentation.
Included Plugins
Headache
An easy-to-swallow painkiller plugin for WordPress. It removes a lot of default WordPress stuff you just can't wait to get rid of. It removes meta tags such as feeds, version numbers and emojis.
Clean Image Filenames
The plugin automatically converts language accent characters in filenames when uploading to the media library. Characters are converted into browser and server friendly, non-accent characters.
Räksmörgås.jpg
→raksmorgas.jpg
Æblegrød_FTW!.gif
→aeblegrod-ftw.gif
Château de Ferrières.png
→chateau-de-ferrieres.png
Vite.js
Vite is a build tool that provides a faster and leaner development experience for modern web projects. It comes with sensible defaults and is highly extensible via its Plugin and JavaScript APIs with full typing support.
# Start the dev server... npm run dev # Build for production... npm run build
Learn more about Vite's backend integration.
To set up custom SMTP credentials for sending emails in your WordPlate application, you need to configure the required environment variables in your .env
file.
MAIL_HOST=127.0.0.1 MAIL_PORT=2525 MAIL_USERNAME=null MAIL_PASSWORD=null MAIL_ENCRYPTION=null MAIL_FROM_ADDRESS="hello@example.com" MAIL_FROM_NAME="Example"
If you're using a local email service like Mailhog or Mailpit, you need to disable encryption by setting the MAIL_ENCRYPTION
environment variable to null
.
FAQ
Can I add WordPress constants to the environment file?
This is possible by updating the public/wp-config.php
file after the WordPlate application have been created.
define('WP_DISABLE_FATAL_ERROR_HANDLER', env('WP_DISABLE_FATAL_ERROR_HANDLER', false));
+define('WP_ALLOW_MULTISITE', env('WP_ALLOW_MULTISITE', true));
Then you may add the constant to the .env
file.
WP_DEFAULT_THEME=wordplate
+WP_ALLOW_MULTISITE=true
Can I disable WP-Cron and set up a manual cron job?
WordPlate allows you to disable the internal WordPress cron system via the DISABLE_WP_CRON
environment variable:
DISABLE_WP_CRON=true
It is recommended to manually set a cron job if you enable this setting and disable the WordPress cron. You'll need to add the following in your crontab file:
*/5 * * * * curl https://example.com/wp/wp-cron.php
Can I install languages with Composer?
If you want to install language packs using Composer, we recommend looking at the WP Languages project. Below is an example of a composer.json
file that installs the Swedish language pack for WordPress.
{ "require": { "koodimonni-language/core-sv_se": "*", }, "repositories": [ { "type": "composer", "url": "https://wp-languages.github.io", "only": [ "koodimonni-language/*" ] } ], "config": { "allow-plugins": { "koodimonni/composer-dropin-installer": true }, }, "extra": { "dropin-paths": { "public/languages/": [ "vendor:koodimonni-language" ] } } }
Can I rename the public directory?
Update your .gitignore
, composer.json
, .vite.config.js
, and wp-cli.yml
files with the new path to the public
directory. Then, run composer update
in the root of your project.
Can I rename the WordPress directory?
By default WordPlate will put the WordPress in public/wordpress
. If you want to change this there are a couple of steps you need to go through. Let's say you want to change the default WordPress location to public/wp
:
-
Update the
wordpress-install-dir
path in yourcomposer.json
file. -
Update
wordpress
towp
inwordplate/public/.gitignore
. -
Update the last line in the
public/index.php
file to:require __DIR__.'/wp/wp-blog-header.php';
-
Update the
WP_DIR
environment variable in the.env
file towp
. -
If you're using WP-CLI, update the path in the
wp-cli.yml
file topublic/wp
. -
Remove the
public/wordpress
directory if it exist and then runcomposer update
.
Can I rename the theme directory?
For most applications you may leave the theme directory as it is. If you want to rename the wordplate
theme to something else you'll also need to update the WP_DEFAULT_THEME
environment variable in the .env
file.
Can I use WordPlate with Laravel Herd or Valet?
If you're using Laravel Herd or Valet together with WordPlate, you may use our custom driver:
<?php namespace Valet\Drivers\Custom; use Valet\Drivers\BasicValetDriver; class WordPlateValetDriver extends BasicValetDriver { public function serves(string $sitePath, string $siteName, string $uri): bool { return is_dir($sitePath . '/public/wordpress'); } public function isStaticFile(string $sitePath, string $siteName, string $url) { $staticFilePath = $sitePath . '/public' . $url; if ($this->isActualFile($staticFilePath)) { return $staticFilePath; } return false; } public function frontControllerPath(string $sitePath, string $siteName, string $uri): ?string { return parent::frontControllerPath( $sitePath . '/public', $siteName, $this->forceTrailingSlash($uri) ); } private function forceTrailingSlash(string $uri) { if (substr($uri, -1 * strlen('/wordpress/wp-admin')) === '/wordpress/wp-admin') { header('Location: ' . $uri . '/'); exit; } return $uri; } }
Can I use WordPlate with Tinkerwell?
If you're using Tinkerwell together with WordPlate, you may use our custom driver:
<?php final class WordPlateTinkerwellDriver extends WordpressTinkerwellDriver { public function canBootstrap($projectPath) { return file_exists($projectPath . '/public/wordpress/wp-load.php'); } public function bootstrap($projectPath) { require $projectPath . '/public/wordpress/wp-load.php'; } public function appVersion() { return 'WordPlate ' . get_bloginfo('version'); } }
Upgrade Guide
Upgrading from 11 to 12
-
The
wordplate/framework
package has been archived. Update thecomposer.json
file:"require": { - "wordplate/framework": "^11.1", + "composer/installers": "^2.1", + "johnpbloch/wordpress-core-installer": "^2.0", + "johnpbloch/wordpress-core": "^6.0", + "roots/bedrock-autoloader": "^1.0", + "roots/wp-password-bcrypt": "^1.1", + "symfony/http-foundation": "^6.0", + "symfony/var-dumper": "^6.0", + "vlucas/phpdotenv": "^5.4" }
-
Replace your
public/wp-config.php
file with the one in this repository. Remember to save any custom constants defined in yourwp-config.php
file. -
Add the
src/helpers.php
file from this repository and autoload it in thecomposer.json
file:+"autoload": { + "files": [ + "src/helpers.php" + ] +}
-
Run
composer update
in the root of your project.
Upgrading from 10 to 11
-
WordPlate now requires PHP 8.0 or later.
-
Bump the version number in the
composer.json
file to^11.0
. -
Run
composer update
in the root of your project.
Upgrading from 9 to 10
-
WordPlate now requires PHP 7.4 or later.
-
Bump the version number in the
composer.json
file to^10.0
. -
Rename
WP_ENV
toWP_ENVIRONMENT_TYPE
in the environment file. -
Rename
WP_THEME
toWP_DEFAULT_THEME
in the environment file. -
Rename
WP_URL
toWP_HOME
in the environment file (if it exists). -
If you're using the
WP_CACHE
environment variable you'll need to define it in thepublic/wp-config.php
file:$application->run(); +define('WP_CACHE', env('WP_CACHE', false)); $table_prefix = env('DB_TABLE_PREFIX', 'wp_');
-
Optional: Rename
WP_PREFIX
toDB_TABLE_PREFIX
in the following files:.env
.env.example
public/wp-config.php
-
Run
composer update
in the root of your project.
Upgrading from 8 to 9
-
Bump the version number in the
composer.json
file to^9.0
. -
Copy the
public/mu-plugins/mu-plugins.php
file into your project. -
Update the
public/.gitignore
file to allow the newmu-plugins.php
file:-mu-plugins/ +mu-plugins/* +!mu-plugins/mu-plugins.php
-
Run
composer update
in the root of your project.
Upgrading from 7 to 8
-
WordPlate now requires PHP 7.2 or later.
-
Bump the version number in the
composer.json
file to^8.0
.[!Note]
WordPlate 8.0 requires WordPress 5.3 or later. -
Laravel's helper functions is now optional in WordPlate. If you want to use the functions, install the
laravel/helpers
package, with Composer, in the root of your project:composer require laravel/helpers
-
Laravel's collections are now optional in WordPlate. If you want to use collections, install the
tightenco/collect
package, with Composer, in the root of your project:composer require tightenco/collect
-
The
mix
helper function is now optional in WordPlate. If you want to use the function, install theibox/mix-function
package, with Composer, in the root of your project:composer require ibox/mix-function
-
Replace any usage of
asset
,stylesheet_url
andtemplate_url
functions with WordPress'sget_theme_file_uri
function. -
Replace any usage of
stylesheet_path
andtemplate_path
functions with WordPress'sget_theme_file_path
function . -
The
base_path
andtemplate_slug
functions have been removed. -
Run
composer update
in the root of your project.
Upgrading from 6 to 7
-
Bump the version number in the
composer.json
file to^7.0
.[!Note]
WordPlate 7.0 requires WordPress 5.0 or later. -
Update the
realpath(__DIR__)
torealpath(__DIR__.'/../')
in thewp-config.php
file. -
If your public directory isn't named
public
, add the following line to thewp-config.php
file:$application->setPublicPath(realpath(__DIR__));
-
Run
composer update
in the root of your project.
Upgrading from 5 to 6
-
Bump the version number in the
composer.json
file to^6.0
. -
Update the
realpath(__DIR__.'/../')
torealpath(__DIR__)
in thewp-config.php
file. -
Run
composer update
in the root of your project.
Upgrading from 4 to 5
-
Bump the version number in the
composer.json
file to^5.0
. -
Copy and paste the contents of the
wp-config.php
file into your application.[!Note]
Make sure you don't overwrite any of your custom constants. -
Run
composer update
in the root of your project.
Acknowledgements
WordPlate wouldn't be possible without these amazing open-source projects.
composer/installers
motdotla/dotenv
outlandish/wpackagist
roots/bedrock-autoloader
roots/wordpress
roots/wp-password-bcrypt
symfony/http-foundation
symfony/var-dumper
upperdog/clean-image-filenames
vinkla/headache
vitejs/vite
vlucas/phpdotenv
License
The WordPlate package is open-sourced software licensed under the MIT license.