wodby/wordpress-composer

Project template for WordPress projects with composer

0.1.0 2020-11-20 17:05 UTC

Requires

• composer/installers: ^1.2
• drupal-composer/preserve-paths: ^0.1
• johnpbloch/wordpress-core: ~5.0
• johnpbloch/wordpress-core-installer: ^2.0

GPL-2.0+

README

This project template should provide a kickstart for managing your site dependencies with Composer.

This project consist of:

• WordPress core: johnpbloch/wordpress-core-installer
• Repository https://wpackagist.org/ to install WordPress plugins and themes
• composer/installers to set custom paths for plugins and themes
• drupal-composer/preserve-paths to exclude paths for plugins and themes under version control
• wodby.yml that runs composer install. You can remove it if you're not using Wodby

Current WordPress core: ~5.0

Paths

By default, wordpress core will be installed in ./web directory. Plugins and themes will be installed in ./web/wp-content/plugins and ./web/wp-content/themes. Point your Apache vhost or similar to this project's ./web directory.

Usage

First you need to install composer.

Note: The instructions below refer to the global composer installation. You might need to replace composer with php composer.phar (or similar) for your setup.

Start a new project:

composer create-project wodby/wordpress-composer some-dir --stability dev --no-interaction

The composer create-project command passes ownership of all files to the project that is created. You should create a new git repository, and commit all files not excluded by the .gitignore file.

How to install WordPress plugins and themes?

With composer require ... you can download new dependencies to your installation.

cd some-dir
composer require wpackagist-plugin/wp-cfm

How to manage my custom themes and plugins under version control?

1. Exclude path to your plugin or theme from .gitignore. Example for theme under web/wp-content/themes/my-custom-theme/:

   !web/
   web/*
   !web/wp-content/
   web/wp-content/*
   !web/wp-content/themes/
   web/wp-content/themes/*
   !web/wp-content/themes/my-custom-theme/
   

2. Add the same path to your composer.json under extra > preserve-paths:

   "preserve-paths": [
     "web/wp-content/themes/custom"
   ]
   

3. Add your plugin/theme directory under version control
4. Run composer install. Composer will install WordPress core and keep your custom theme

Deployment via Wodby

1. Create a new project.
2. Connect the repository to Wodby.
3. Deploy new app, choose WordPress stack, on the 2nd step of the form choose connected repository and enter web as Codebase dir.