Engineering Best Practices
Search…
Structure
Theme and Plugin File Organization
File structure unity across themes and plugins improves engineering efficiency and maintainability. We believe the following structure is segmented enough to keep projects organized—and thus maintainable—but also flexible and open ended enough to enable engineers to comfortably modify as necessary. All themes and plugins should derive from this structure:
1
|- assets/
2
| |- css/ _______________________________ # See below for details
3
| |- fonts/ _____________________________ # Custom/hosted fonts
4
| |- images/ ____________________________ # Theme images
5
| |- js/ ________________________________ # See below for details
6
| |- svg/ _______________________________ # Vector images that will be processed into icons
7
|- bin/ __________________________________ # WP-CLI and other scripts
8
|- gulp-tasks/ ___________________________ # Individual Gulp tasks
9
|- includes/ _____________________________ # PHP classes and files
10
| |- classes/ _________________________ # PHP classes
11
|- languages/ ____________________________ # Translations
12
|- node_modules/ _________________________ # npm modules
13
|- partials/ _____________________________ # Template parts
14
|- templates/ ____________________________ # Page templates
15
|- tests/
16
| |- php/ _______________________________ # PHP testing suite
17
| |- js/ ________________________________ # JavaScript testing suite
18
|- vendor/ _______________________________ # Composer dependencies
19
|- .babelrc ______________________________ # Babel config settings
20
|- .editorconfig _________________________ # Editor config settings
21
|- .eslintrc _____________________________ # ESLint config settings
22
|- composer.json _________________________ # Composer package file
23
|- gulpfile.babel.js _____________________ # Gulp config settings
24
|- package.json __________________________ # npm package file
25
|- webpack.config.babel.js _______________ # Webpack config settings
Copied!
The
CSS folder is described separately, below to improve readability:1
|- assets/css/
2
| |- admin/ ___________________________ # CSS for the admin
3
| |- frontend/ ________________________ # CSS for the front end
4
| |- base/ _________________________ # CSS at the top of the cascade
5
| |- components/ ___________________ # Component-level CSS
6
| |- global/ _______________________ # Variables and configs
7
| |- layout/ _______________________ # Layout and helper classes
8
| |- templates/ ____________________ # CSS for specific templates
9
| |- shared/ __________________________ # Shared CSS between the admin and front end
Copied!
The
JS folder is described separately, below to improve readability:1
|- assets/js/
2
| |- admin/ ___________________________ # JS for the admin
3
| |- frontend/ ________________________ # JS for the front end
4
| |- components/ ___________________ # Component-level JS
5
| |- shared/ __________________________ # Shared JS between the admin and front end
Copied!
Dependencies and Package Management
Projects generally use two different types of dependency management:
When and How to Use Packages
When choosing a third-party library for inclusion in your project, see if it’s available on npm (JavaScript) or Packagist (PHP). Additionally, WordPress plugins and themes are often available on wpackagist.org. Retrieving dependencies from a package repo helps slim down the code in our version control repos, meaning there’s less we need to retrieve when a new engineer starts on a project. It also contributes to easily keeping code up to date with security and performance improvements.
Most package managers differentiate between dependencies and devDependencies:
- devDependencies are code, often build tools like Webpack or Gulp, needed to get a site to a production-ready state.
- Dependencies are code actually used in the functioning of the site, like Lodash or Normalize.css.
Existing projects that weren’t built with package managers in mind offer an opportunity for engineering teams to implement them for all new development. Teams should also estimate and plan around the time needed to retrofit the existing codebase.
With some projects, using an automated dependency manager won’t make sense. In server environments like VIP, running dependency software on the server is impossible. If required repositories are private (i.e. invisible to the clients’ in-house developers), expecting the entire team to use a dependency manager is unreasonable. In these cases, the dependency, its version, and the reason for its inclusion in the project outside of a dependency manager should be documented.
If you are using a package where the naming and usage isn’t obvious to the average engineer, be sure to document its purpose in the README, style guide, or project documentation.
Selecting Packages
Packages are often a Matryoshka of their own dependencies. Though this code is almost certainly all open source, it’s not practical to apply the same scrutiny to packages’ code as is expected before selecting WordPress themes and plugins. Effective package selection, therefore, relies on other factors that engineers can quickly evaluate:
- Is the package actively developed and supported?
- Does the package have a solid reputation in the community?
- How frequently have security issues been reported, and how quickly have they historically been addressed?
- Does the package require a small number of dependencies?
- How easily could the packages’ code be forked in case it’s abandoned or a critical issue needs to be addressed right away? When evaluating this, consider the package’s open source license along with the ease of modifying the code.
Package Versions and Lock
When installing a package, engineers can specify a version string the package manager uses to select an appropriate package version. Never specify an exact x.y.z version or else security, performance, and functionality upgrades won’t be available. Most third-party packages follow the Semantic Versioning (semver.org) system, where packages’ version numbers are defined in terms of major, minor, and patch levels. Changes to semver-compliant packages are expected to trigger a new major version when breaking backward compatibility.
Instead of a full x.y.z version, Specify major & minor versions x.y to minimize the risk of breaking changes being introduced into your project. Start version number strings with a caret (^) for most dependencies, for example ^1.2
For dependencies that don’t use semver, like many WordPress themes and plugins, engineers should still specify major and minor versions x.y. Start version numbers with a tilde (~) for most dependencies.
Modern package managers create lock files, such as npm’s
package-lock.json and Composer’s composer.lock. These files record the package versions each package manager chose to satisfy the version number constraints on the current version of the platform. Lock files should be committed to project version control repos so all engineers can be on the same page.Composer Based Project Structure
Here’s how we might structure a project with Composer:
1
|- composer.json ____________________________ # Define third party dependencies
2
|- wp-config.php ____________________________ # WordPress configuration
3
|- wordpress/ _______________________________ # Composer install WordPress here
4
|- wp-content/ ______________________________ # Composer dependencies
5
| |- plugins/ ______________________________ # Plugins directory
6
| |- custom-plugin/ ______________________ # Custom plugin
7
| |- themes/ _______________________________ # Themes directory
8
| |- custom-theme/ _______________________ # Custom theme
Copied!
Here’s what
composer.json might look like with some example plugins:1
{
2
"name": "xwp/project-slug",
3
"description": "Project description",
4
"repositories":[
5
{
6
"type":"composer",
7
"url":"https://wpackagist.org"
8
}
9
],
10
"extra": {
11
"wordpress-install-dir": "wordpress",
12
"installer-paths": {
13
"wp-content/plugins/{$name}/": ["type:wordpress-plugin"],
14
"wp-content/themes/{$name}/": ["type:wordpress-theme"]
15
}
16
},
17
"require": {
18
"johnpbloch/wordpress": "5.2",
19
"wpackagist-plugin/wordpress-importer": "dev-trunk",
20
"wpackagist-plugin/debug-bar": "dev-trunk",
21
"wpackagist-plugin/debug-bar-extender": "dev-trunk",
22
"wpackagist-theme/twentyseventeen": "2.2"
23
}
24
}
Copied!
Third-Party Integrations
Any and all third-party integrations need to be documented in an
INTEGRATIONS.md file at the root of the project repository. This file includes a list of third-party services, which components of the project those services power, how the project interacts with the remote APIs, and when the interaction is triggered. An integration that could result in unexpected consequences during something like a migration (such as sending out a tweet) should be clearly documented (see Migrations section).For example:
1
## CrunchBase
2
Remote service for fetching funding and other investment data related to tech startups.
3
4
### Scheduling
5
- The CrunchBase API is used via JS in a dynamic product/company search on post edit pages
6
- Funding data is pulled every 6 hours by WP Cron to update cached data
7
8
### Integration Points
9
- /assets/js/src/crunchbase-autocomplete.js
10
- /includes/classes/crunchbase.php
11
- /includes/classes/cron.php
12
13
### Development API
14
- See https://somesitethatrequireslogin.com/credentials-for-project
Copied!
API Keys and Credentials
Authentication credentials and API keys should never be hard-coded into a project. Hard-coding production credentials leads to embarrassing eventualities like posting development content to Twitter or emailing such content to clients’ mail lists.
Where possible, the project should expose a UI for entering and managing third party credentials.
If a management UI is impossible due to the nature of the project, credentials should be loaded via either PHP constants or WordPress filters. These options can - and should - default to developer credentials in the absence of production data.
1
<?php
2
// Production API keys should ideally be defined in wp-config.php
3
// This section should default to a development or noop key instead.
4
if ( ! defined( 'CLIENT_MANDRILL_API_KEY' ) && ! ENV_DEVELOPMENT ) {
5
define( 'CLIENT_MANDRILL_API_KEY', '1234567890' );
6
}
Copied!
The
ENV_DEVELOPMENT constant should always be set to true for local development and should be used whenever and wherever possible to prevent production-only functionality from triggering in a local environment.The location where other engineers can retrieve developer API keys (i.e. project management tool) can and should be logged in the
INTEGRATIONS.md file to aid in local testing. Production API keys must never be stored in the repository, neither in text files or hard-coded into the project itself. Never share private credentials with Slack, use Keybase instead — you will get an invite to the team once hired.Modular Code
Every project, whether a plugin a theme or a standalone library, should be coded to be reusable and modular. The line between a theme and a plugin is often fuzzy in the WordPress community, but there should be a clear distinction between the two.
Plugins
Any site-specific configuration for a plugin should be added to a special
mu-plugin that is specifically designated for this purpose.If the code for a project is split off into a functionality plugin, it should be done in such a way that the theme can function when the functionality plugin is disabled, broken, or missing. Each plugin should operate within its own namespace, both in terms of code isolation and in terms of internationalization.
Any functions the plugin exposes for use in a theme should be done so through actions and filters - the plugin should contain multiple calls to
add_filter() and add_action() as the hooks themselves will be defined in the theme.Plugins should have unit tests. Use our
block-extend or wp-foo-bar plugin scaffold for initializing new plugins.Themes
Themes should only handle presentation: templates, layouts, styles, and configuration (registering sidebars, menu locations, theme support, etc).
Any site-specific configuration that isn't directly related to a theme should go into a site-specific plugin (e.g. a
mu-plugin). This doesn't apply to sites on WordPress.com VIP, plugins are usually bundled with the theme and mu-plugins aren't supported.Any logic in the theme's
functions.php should be simple and directly related to presentation; any other logic should be put into a plugin (e.g. post types, taxonomies, rewrite rules).Any theme dependencies on functionality plugins should be built with the use of
do_action()or apply_filters().In short, changing to the default theme should not trigger errors on a site. Nor should disabling a functionality plugin - every piece of code should be decoupled and use standard WordPress paradigms (hooks) for interacting with one another.
General Notes
Each theme/plugin/site repo should include a copy of the
wp-dev-lib, along with the config files for PHPCS, ESLint, JSCS, Travis CI, and other required tools. Follow the readme for installation and configuration instructions.Every project, whether it includes Composer-managed dependencies or not, must contain a
composer.json file defining the project so it can in turn be pulled in to other projects via Composer.For example:
1
{
2
"name": "xwp/{project name}",
3
"type": "wordpress-plugin",
4
"minimum-stability": "dev",
5
"require-dev": {},
6
"require": {},
7
"version": "1.0.0",
8
"dist": {
9
"url": "... stable archive package URI ...",
10
"type": "zip"
11
}
12
}
Copied!
When code is being reused between projects, it should be abstracted into a standalone library that those projects can pull in through Composer. Generally, code is client or project specific, but if it's abstract enough to be reused we want to capture that and maintain the code in one place rather than copy-pasting it between repositories.
Editor Config
Every project should include an Editor Config file,
.editorconfig in the root directory. This file will define and maintain consistent coding styles between the different IDEs and Code Editors used on the project.All developers should install the corresponding Editor Config plugin for their preferred development editor from EditorConfig.org.
The editor config file with standard settings for commonly used files is shown below.
1
root = true
2
3
[*]
4
charset = utf-8
5
end_of_line = lf
6
insert_final_newline = true
7
trim_trailing_whitespace = true
8
indent_style = tab
9
10
[{package.json,*.yml}]
11
indent_style = space
12
indent_size = 2
13
14
[{*.txt,wp-config-sample.php}]
15
end_of_line = crlf
Copied!
Developers may extend and/or customize these rules as new file formats are added to the project.
Last modified 6mo ago