PHPackages                             phphaus/bedrock - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. phphaus/bedrock

ActiveProject[Utility & Helpers](/categories/utility)

phphaus/bedrock
===============

A modern WordPress stack customized for phpHaus

1.2.7(11y ago)02MITPHPPHP >=5.3.2

Since Dec 18Pushed 11y ago1 watchersCompare

[ Source](https://github.com/phphaus/bedrock)[ Packagist](https://packagist.org/packages/phphaus/bedrock)[ Docs](http://roots.io/wordpress-stack/)[ RSS](/packages/phphaus-bedrock/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (4)Versions (14)Used By (0)

[Bedrock](http://roots.io/wordpress-stack/)
===========================================

[](#bedrock)

Bedrock is a modern WordPress stack that helps you get started with the best development tools and project structure.

ToC
===

[](#toc)

- [Quick Start](#quick-start)
- [Features](#features)
- [Required](#requirements)
- [Installation/Usage](#installationusage)
    - [via Composer](#using-create-project)
    - [Manually](#manually)
- [Documentation](#folder-structure)
    - [Folder Structure](#folder-structure)
    - [Configuration Files](#configuration-files)
    - [Environment Variables](#environment-variables)
    - [Composer](#composer)
    - [WP-CLI](#wp-cli)
    - [Vagrant/Puppet](#vagrantpuppet)
    - [mu-plugins Autoloader](#mu-plugins-autoloader)
- [Contributing](#contributing)
- [Support](#support)

Quick Start
-----------

[](#quick-start)

Use [phphaus/vagrant-lamp](https://github.com/phphaus/vagrant-lamp) to get started with a development VM customized for Bedrock.

Or run `composer create-project phphaus/bedrock ` (see [Installation/Usage](#installationusage) for more details) to just get a new copy of Bedrock locally.

Features
--------

[](#features)

- Dependency management with [Composer](http://getcomposer.org)
- Better folder structure
- Easy WordPress configuration with environment specific files
- Environment variables with [Dotenv](https://github.com/vlucas/phpdotenv)
- Easy server environments with [Vagrant](http://www.vagrantup.com/) and [Ansible](http://www.ansible.com/home) - [bedrock-ansible](https://github.com/roots/bedrock-ansible) on GitHub
- Autoloader for mu-plugins (let's you use regular plugins as mu-plugins)

Bedrock is meant as a base for you to fork and modify to fit your needs. It is delete-key friendly and you can strip out or modify any part of it. You'll also want to customize Bedrock with settings specific to your sites/company.

Much of the philosphy behind Bedrock is inspired by the [Twelve-Factor App](http://12factor.net/) methodology including the [WordPress specific version](http://roots.io/twelve-factor-wordpress/).

Note: While this is a project from the guys behind the [Roots starter theme](http://roots.io/starter-theme/), Bedrock isn't tied to Roots in any way and works with any theme.

Requirements
------------

[](#requirements)

- Git
- PHP >= 5.3.2 (for Composer)

If you aren't interested in using a part, then you don't need its requirements either.

Installation/Usage
------------------

[](#installationusage)

See [Documentation](#documentation) for more details on the steps below.

### Using `create-project`

[](#using-create-project)

Composer's `create-project` command will automatically install the Bedrock project to a directory and run `composer install`.

The post-install script will automatically copy `.env.example` to `.env` and you'll be prompted about generating salt keys and appending them to your `.env` file.

Note: To generate salts without a prompt, run `create-project` with `-n` (non-interactive). You can also change the `generate-salts` setting in `composer.json` under `config` in your own fork. The default is `true`.

To skip the scripts completely, `create-project` can be run with `--no-scripts` to disable it.

1. Run `composer create-project phphaus/bedrock ` (`path` being the folder to install to). User syntax `composer create-project=1.3.x-dev phphaus/bedrock ` to install a particular version.
2. Edit `.env` and update environment variables:

- `DB_NAME` - Database name
- `DB_USER` - Database user
- `DB_PASSWORD` - Database password
- `DB_HOST` - Database host (defaults to `localhost`)
- `WP_ENV` - Set to environment (`development`, `staging`, `production`, etc)
- `WP_HOME` - Full URL to WordPress home ()
- `WP_SITEURL` - Full URL to WordPress including subdirectory ()

3. Add theme(s)
4. Set your Nginx or Apache vhost to `/path/to/site/resources/public/`
5. Access WP Admin at `http://example.com/wp/wp-admin`

### Manually

[](#manually)

1. Clone/Fork repo
2. Run `composer install`
3. Copy `.env.example` to `.env` and update environment variables:

- `DB_NAME` - Database name
- `DB_USER` - Database user
- `DB_PASSWORD` - Database password
- `DB_HOST` - Database host (defaults to `localhost`)
- `WP_ENV` - Set to environment (`development`, `staging`, `production`, etc)
- `WP_HOME` - Full URL to WordPress home ()
- `WP_SITEURL` - Full URL to WordPress including subdirectory ()

4. Add theme(s)
5. Set your Nginx or Apache vhost to `/path/to/site/resources/public/`
6. Access WP Admin at `http://example.com/wp/wp-admin`

Documentation
-------------

[](#documentation)

### Folder Structure

[](#folder-structure)

```
├── composer.json
├── build
├── resources
│    ├── config
│    │   ├── application.php
│    │   ├── environments
│    │   │   ├── development.php
│    │   │   ├── staging.php
│    │   │   └── production.php
│    │   └── application.php
│    └── public
│        ├── app
│        │   ├── mu-plugins
│        │   ├── plugins
│        │   └── themes
│        ├── wp-config.php
│        ├── index.php
│        └── wp
├── src
├── test
└── vendor

```

The organization of Bedrock is similar to putting WordPress in its own subdirectory but with some improvements.

- In order not to expose sensitive files in the webroot, Bedrock moves what's required into a `resources/public/` directory including the vendor'd `wp/` source, and the `wp-content` source.
- `wp-content` (or maybe just `content`) has been named `app` to better reflect its contents. It contains application code and not just "static content". It also matches up with other frameworks such as Symfony and Rails.
- `wp-config.php` remains in the `resources/public/` because it's required by WP, but it only acts as a loader. The actual configuration files have been moved to `resources/config/` for better separation.
- `vendor/` is where the Composer managed dependencies are installed to.
- `wp/` is where the WordPress core lives. It's also managed by Composer but can't be put under `vendor` due to WP limitations.

### Configuration Files

[](#configuration-files)

The root `resources/public/wp-config.php` is required by WordPress and is only used to load the other main configs. Nothing else should be added to it.

`resources/config/application.php` is the main config file that contains what `wp-config.php` usually would. Base options should be set in there.

For environment specific configuration, use the files under `resources/config/environments`. By default there's is `development`, `staging`, and `production` but these can be whatever you require.

The environment configs are required **before** the main `application` config so anything in an environment config takes precedence over `application`.

Note: You can't re-define constants in PHP. So if you have a base setting in `application.php` and want to override it in `production.php` for example, you have a few options:

- Remove the base option and be sure to define it in every environment it's needed
- Only define the constant in `application.php` if it isn't already defined.

#### Don't want it?

[](#dont-want-it)

You will lose the ability to define environment specific settings.

- Move all configuration into `wp-config.php`
- Manually deal with environment specific options
- Remove `config` directory

### Environment Variables

[](#environment-variables)

Bedrock tries to separate config from code as much as possible and environment variables are used to achieve this. The benefit is there's a single place (`.env`) to keep settings like database or other 3rd party credentials that isn't committed to your repository.

[PHP dotenv](https://github.com/vlucas/phpdotenv) is used to load the `.env` file. All variables are then available in your app by `getenv`, `$_SERVER`, or `$_ENV`.

Currently, the following env vars are required:

- `DB_USER`
- `DB_NAME`
- `DB_PASSWORD`
- `WP_HOME`
- `WP_SITEURL`

#### Don't want it?

[](#dont-want-it-1)

You will lose the separation between config and code and potentially put secure credentials at risk.

- Remove `dotenv` from `composer.json` requires
- Remove `.env.example` file from root
- Remove `require_once('vendor/autoload.php');` from `wp-config.php`
- Replace all `getenv` calls with whatever method you want to set those values

### Composer

[](#composer)

[Composer](http://getcomposer.org) is used to manage dependencies. Bedrock considers any 3rd party library as a dependency including WordPress itself and any plugins.

See these two blogs for more extensive documentation:

- [Using Composer with WordPress](http://roots.io/using-composer-with-wordpress/)
- [WordPress Plugins with Composer](http://roots.io/wordpress-plugins-with-composer/)

Screencast ($): [Using Composer With WordPress](http://roots.io/screencasts/using-composer-with-wordpress/)

#### Plugins

[](#plugins)

[WordPress Packagist](http://wpackagist.org/) is already registered in the `composer.json` file so any plugins from the [WordPress Plugin Directory](http://wordpress.org/plugins/) can easily be required.

To add a plugin, add it under the `require` directive or use `composer require /` from the command line. If it's from WordPress Packagist then the namespace is always `wpackagist-plugin`.

Example: `"wpackagist-plugin/akismet": "dev-trunk"`

Whenever you add a new plugin or update the WP version, run `composer update` to install your new packages.

`plugins`, and `mu-plugins` are Git ignored by default since Composer manages them. If you want to add something to those folders that *isn't* managed by Composer, you need to update `.gitignore` to whitelist them:

`!resources/public/app/plugins/plugin-name`

Note: Some plugins may create files or folders outside of their given scope, or even make modifications to `wp-config.php` and other files in the `app` directory. These files should be added to your `.gitignore` file as they are managed by the plugins themselves, which are managed via Composer. Any modifications to `wp-config.php` that are needed should be moved into `config/application.php`.

#### Updating WP and plugin versions

[](#updating-wp-and-plugin-versions)

Updating your WordPress version (or any plugin) is just a matter of changing the version number in the `composer.json` file.

Then running `composer update` will pull down the new version.

#### Themes

[](#themes)

Themes can also be managed by Composer but should only be done so under two conditions:

1. You're using a parent theme that won't be modified at all
2. You want to separate out your main theme and use that as a standalone package

Under most circumstances we recommend NOT doing #2 and instead keeping your main theme as part of your app's repository.

Just like plugins, WPackagist maintains a Composer mirror of the WP theme directory. To require a theme, just use the `wpackagist-theme` namespace.

#### Don't want it?

[](#dont-want-it-2)

Composer integration is the biggest part of Bedrock, so if you were going to remove it there isn't much point in using Bedrock.

#### DB Syncing

[](#db-syncing)

Bedrock doesn't come with anything by default to do DB syncing yet. The best option is to use WP-CLI.

### wp-cron

[](#wp-cron)

Bedrock disables the internal WP Cron via `define('DISABLE_WP_CRON', true);`. If you keep this setting, you'll need to manually set a cron job like the following in your crontab file:

`*/5 * * * * curl http://example.com/wp/wp-cron.php`

WP-CLI
------

[](#wp-cli)

Bedrock works with [WP-CLI](http://wp-cli.org/) just like any other WordPress project would. Previously we required WP-CLI in our `composer.json` file as a dependency. This has been removed since WP-CLI now recommends installing it globally with a `phar` file. It also caused conflicts if you tried using a global install.

The `wp` command will automatically pick up Bedrock's subdirectory install as long as you run commands from within the project's directory (or deeper). Bedrock includes a `wp-cli.yml` file that sets the `path` option to `resources/public/wp`. Use this config file for any further [configuration](http://wp-cli.org/config/).

Vagrant/Puppet
--------------

[](#vagrantpuppet)

Vagrant integration with Bedrock can now be found in the separate [phphaus/vagrant-lamp](https://github.com/phphaus/vagrant-lamp) project. Basic instructions exist in that project's README, but if you want a Vagrant box tied to a specific Bedrock based WP application, copy the example `Vagrantfile` into your app's repo and edit the necessary file paths.

mu-plugins autoloader
---------------------

[](#mu-plugins-autoloader)

Bedrock includes an autoloader that enables standard plugins to be required just like must-use plugins. The autoloaded plugins are included after all mu-plugins and standard plugins have been loaded. An asterisk (\*) next to the name of the plugin designates the plugins that have been autoloaded. To remove this functionality, just delete `resources/public/app/mu-plugins/bedrock-autoloader.php`.

This enables the use of mu-plugins through Composer if their package type is `wordpress-muplugin`. You can also override a plugin's type like the following example:

```
"installer-paths": {
  "resources/public/app/mu-plugins/{$name}/": ["type:wordpress-muplugin", "roots/soil"],
  "resources/public/app/plugins/{$name}/": ["type:wordpress-plugin"],
  "resources/public/app/themes/{$name}/": ["type:wordpress-theme"]
},
```

[Soil](https://github.com/roots/soil) is a package with its type set to `wordpress-plugin`. Since it implements `composer/installers` we can override its type.

Todo
----

[](#todo)

- Solution for basic database syncing/copying

Contributing
------------

[](#contributing)

Everyone is welcome to help [contribute](CONTRIBUTING.md) and improve this project. There are several ways you can contribute:

- Reporting issues (please read [issue guidelines](https://github.com/necolas/issue-guidelines))
- Suggesting new features
- Writing or refactoring code
- Fixing [issues](https://github.com/roots/bedrock/issues)
- Replying to questions on the [forum](http://discourse.roots.io/)

Support
-------

[](#support)

Use the [Roots Discourse](http://discourse.roots.io/) forum to ask questions and get support.

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity2

Limited adoption so far

Community19

Small or concentrated contributor base

Maturity65

Established project with proven stability

 Bus Factor1

Top contributor holds 65.3% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~26 days

Recently: every ~35 days

Total

11

Last Release

4273d ago

PHP version history (2 changes)1.0.0PHP >=5.3.0

1.1.0PHP >=5.3.2

### Community

Maintainers

![](https://www.gravatar.com/avatar/d499cdf9bcd21ec3f25110398a703f37f6a88b50d4ef9d2970a23e30329496ee?d=identicon)[phpPhil](/maintainers/phpPhil)

---

Top Contributors

[![swalkinshaw](https://avatars.githubusercontent.com/u/295605?v=4)](https://github.com/swalkinshaw "swalkinshaw (77 commits)")[![retlehs](https://avatars.githubusercontent.com/u/115911?v=4)](https://github.com/retlehs "retlehs (11 commits)")[![phpPhil](https://avatars.githubusercontent.com/u/4443862?v=4)](https://github.com/phpPhil "phpPhil (8 commits)")[![aaemnnosttv](https://avatars.githubusercontent.com/u/1621608?v=4)](https://github.com/aaemnnosttv "aaemnnosttv (2 commits)")[![etcook](https://avatars.githubusercontent.com/u/2329397?v=4)](https://github.com/etcook "etcook (2 commits)")[![fredriksundstrom](https://avatars.githubusercontent.com/u/1112071?v=4)](https://github.com/fredriksundstrom "fredriksundstrom (2 commits)")[![BrandonShutter](https://avatars.githubusercontent.com/u/2022885?v=4)](https://github.com/BrandonShutter "BrandonShutter (2 commits)")[![8ig8](https://avatars.githubusercontent.com/u/241335?v=4)](https://github.com/8ig8 "8ig8 (1 commits)")[![iloveitaly](https://avatars.githubusercontent.com/u/150855?v=4)](https://github.com/iloveitaly "iloveitaly (1 commits)")[![jonknapp](https://avatars.githubusercontent.com/u/8836231?v=4)](https://github.com/jonknapp "jonknapp (1 commits)")[![nmec](https://avatars.githubusercontent.com/u/943232?v=4)](https://github.com/nmec "nmec (1 commits)")[![QWp6t](https://avatars.githubusercontent.com/u/2104321?v=4)](https://github.com/QWp6t "QWp6t (1 commits)")[![remyvv](https://avatars.githubusercontent.com/u/2862815?v=4)](https://github.com/remyvv "remyvv (1 commits)")[![rslnk](https://avatars.githubusercontent.com/u/5638534?v=4)](https://github.com/rslnk "rslnk (1 commits)")[![francescolaffi](https://avatars.githubusercontent.com/u/357331?v=4)](https://github.com/francescolaffi "francescolaffi (1 commits)")[![alexsomeoddpilot](https://avatars.githubusercontent.com/u/5588412?v=4)](https://github.com/alexsomeoddpilot "alexsomeoddpilot (1 commits)")[![austinpray](https://avatars.githubusercontent.com/u/2192970?v=4)](https://github.com/austinpray "austinpray (1 commits)")[![benjibee](https://avatars.githubusercontent.com/u/620119?v=4)](https://github.com/benjibee "benjibee (1 commits)")[![DArtagan](https://avatars.githubusercontent.com/u/69908?v=4)](https://github.com/DArtagan "DArtagan (1 commits)")[![eastmanenator](https://avatars.githubusercontent.com/u/70497?v=4)](https://github.com/eastmanenator "eastmanenator (1 commits)")

---

Tags

composerwordpressstackwpvagrantcapistrano

### Embed Badge

![Health badge](/badges/phphaus-bedrock/health.svg)

```
[![Health](https://phpackages.com/badges/phphaus-bedrock/health.svg)](https://phpackages.com/packages/phphaus-bedrock)
```

###  Alternatives

[roots/bedrock

WordPress boilerplate with Composer, easier configuration, and an improved folder structure

6.5k441.8k2](/packages/roots-bedrock)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)