invokemedia / wordpress-starter

A submodule installation of WordPress including the WordPress testing suite, linting, formatting, autoloading, Docker, and wp-cli

WordPress Starter

A submodule installation of WordPress including the WordPress testing suite, linting, formatting, and wp-cli

Cloning

Since this project has a submodule (WordPress) you need to clone recursively:

git clone [e-mail]:invokemedia/wordpress-starter.git --recursive

Running in Docker

You can use the provided Dockerfile or use docker-compose to run the application. The image being used is called webdevops/php-nginx.

To use the Dockerfile to build, you need to run the following commands:

docker build -t my-tag-name .
docker run --net=host -p 80:80 -p 3306:3306 my-tag-name:latest

The --net=host flag is required, as it allows us to use the host MySQL database.

Important Note

If you are using docker in any fashion, you will need to set the wp-config.php DB_HOST to dockerhost.

Setup

This project works with Laravel Valet if you have the WordpressSubDirectoryValetDriver installed.

You can also use the included .htaccess file as long as you update it with the correct information for local development.

Install

You will need to setup and configure the following files:

1. wp-config-sample.php to wp-config.php
2. wp-tests-config-sample.php to wp-tests-config.php
3. Fill out the empty strings that need values
4. Run composer install

Note: Be sure to put different details in wp-tests-config.php as it will write to that database as part of the testing. You can use the same database for testing, but it adds new tables with a prefix of wptests_ to the database.

Important Note For Docker

If you are using docker in any fashion, you will need to set the wp-config.php DB_HOST to dockerhost.

Apache Note

Be sure to update the apache .htaccess file with your domain to the requests to WordPress are rewritten correctly.

Nginx Note

You will need to add the conf/nginx/nginx-site.conf block of code to your sites virtual host file.

Included Packages

We include some dev packages by default for testing, formatting, and linting code. We also include wp-cli which is installed via composer as well.

One of the additional packages is invokemedia/laravel-helpers which we use to complete some of the missing array_* methods in PHP. These functions help us write more concise code and reduce repeating blocks of code. This is expecially important when working with arrays of Post objects.

Plugins

There are no plugins included but we recommend installing the invokemedia/invoke-helpers as a must-use plugin. It wraps up some of the base WordPress functions in nicer abstractions.

Commands

The composer setup includes some commands that can be run manually or also run after an update:

1. composer run test: runs the phpunit tests
2. composer run sniff: runs phpcs command on the theme
3. composer run lint: runs php linting on the theme code
4. composer run mess: runs phpmd on the theme code
5. composer run all: runs test, sniff, and lint together

WP-CLI command

The wp-cli command is installed via composer. You can access the command as ./vendor/bin/wp.

Testing

Just run phpunit from the root of the project.