Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wodby/wordpress-composer
Composer template for WordPress projects.
https://github.com/wodby/wordpress-composer
composer wordpress
Last synced: about 1 month ago
JSON representation
Composer template for WordPress projects.
- Host: GitHub
- URL: https://github.com/wodby/wordpress-composer
- Owner: wodby
- License: gpl-2.0
- Created: 2017-07-24T09:05:46.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-07-11T09:29:01.000Z (over 2 years ago)
- Last Synced: 2024-11-07T05:20:21.836Z (about 2 months ago)
- Topics: composer, wordpress
- Homepage:
- Size: 19.5 KB
- Stars: 69
- Watchers: 8
- Forks: 47
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Composer Template for WordPress Projects
This project template should provide a kickstart for managing your site dependencies with [Composer](https://getcomposer.org/).
This project consist of:
* WordPress core: [johnpbloch/wordpress-core-installer](https://github.com/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](https://wodby.com)
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](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx).
> Note: The instructions below refer to the [global composer installation](https://getcomposer.org/doc/00-intro.md#globally). 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.