buzzedword/wordpress-skeleton

Mark Jaquith's Wordpress Skeleton modified to use composer. WPackagist is included as a repository, as well as custom installer paths for all wp-composer packages. This is a fork.

3.7.1 2013-11-22 17:26 UTC

Requires

• php: >=5.3.0
• fancyguy/webroot-installer: 1.0.0
• wordpress/wordpress: *

Suggests

• roots/roots: A great theme which inspired this composer build, and has a modern structure.
• wpackagist/developer: Automattic Developer allows for comprehensive best practices to be used during plugin or theme development.
• wpackagist/jetpack: Wordpress Jetpack allows for comprehensive best practices to be used during publishing.

GPL-2.0

README

This is simply a skeleton repo for a WordPress site. Use it to jump-start your WordPress site repos, or fork it and customize it to your own liking!

Assumptions

• WordPress as a Git submodule in /wp/
• Custom content directory in /content/ (cleaner, and also because it can't be in /wp/)
• wp-config.php in the root (because it can't be in /wp/)
• All writable directories are symlinked to similarly named locations under /shared/.
• Composer is either installed globally, or this project has been installed as a new composer project.

Installation

composer install --prefer-dist

Questions & Answers

Q: Will you accept pull requests? A: Maybe — if I think the change is useful. I primarily made this for my own use, and thought people might find it useful. If you want to take it in a different direction and make your own customized skeleton, then just maintain your own fork.

Q: Why the /shared/ symlink stuff for uploads? A: For local development, create /shared/ (it is ignored by Git), and have the files live there. For production, have your deploy script (Capistrano is my choice) look for symlinks pointing to /shared/ and repoint them to some outside-the-repo location (like an NFS shared directory or something). This gives you separation between Git-managed code and uploaded files.

Q: What version of WordPress does this track? A: The latest stable release. Send a pull request if I fall behind.

Q: What's the deal with local-config.php? A: It is for local development, which might have different MySQL credentials or do things like enable query saving or debug mode. This file is ignored by Git, so it doesn't accidentally get checked in. If the file does not exist (which it shouldn't, in production), then WordPress will used the DB credentials defined in wp-config.php.

Q: What is memcached.php? A: This is for people using memcached as an object cache backend. It should be something like: <?php return array( "server01:11211", "server02:11211" ); ?>. Programattic generation of this file is recommended.

Q: Does this support WordPress in multisite mode? A: It will, starting with WordPress 3.5 (due out in December, 2012). Earlier versions of WordPress don't support Multisite when WordPress is in a subdirectory.