phycticio/wp-boilerplate

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

v1.0.17 2025-03-13 11:42 UTC

Requires

• php: >=8.1
• ext-pdo: *
• composer/installers: ^2.2
• oscarotero/env: ^2.1
• ramsey/uuid: ^4.7
• roots/bedrock-autoloader: ^1.0
• roots/wordpress: 6.7.1
• roots/wp-config: 1.0.0
• roots/wp-password-bcrypt: 1.2.0
• timber/timber: ^2.3
• vlucas/phpdotenv: ^5.5

Requires (Dev)

• laravel/pint: ^1.18
• roave/security-advisories: dev-latest
• wpackagist-plugin/wp-crontrol: ^1.17

Suggests

• wpackagist-plugin/loco-translate: ^2.7
• wpackagist-plugin/user-role-editor: ^4.64

MIT

• Javier Troya

• composer
• wordpress
• boilerplate
• wp
• wp-config
• mody

README

Modern template for WordPress development with scalable architecture and updated technology stack.

Key Features

• 🚀 Modern Stack: PHP 8.1+, Node 18+, Composer 2+, pnpm
• 🧩 Dependency Management:
  • Plugins managed via Composer
  • Assets with Webpack 5 and ES6+
• 🧱 Block Theme:
  • Native blocks with React
  • Full Site Editing (FSE)
  • Complete frontend/backend integration
• 📐 Clean Architecture:
  • MVC pattern with Twig templating
  • Environment-based configuration
  • Clear separation of responsibilities
• ⚙️ Professional Workflow:
  • Integrated GitHub Actions
  • PHP Code Standards (Pint)
  • Multi-environment Webpack

Prerequisites

• PHP 8.1+
• Node.js 18+
• Composer 2.2+
• pnpm 8+

Quick Installation

composer create-project phycticio/wp-boilerplate project-name
cd project-name
cp sample.env .env
pnpm install
pnpm run build

Configuration

Environments

1. Edit .env with your variables
2. Configure environments in config/environments/
   • development.php: Local config
   • production.php: Production config

Main Files

• config/application.php: Shared configuration
• web/wp-config.php: WordPress Bootstrap
• app/App.php: Theme initializer

Directory Structure

wp-boilerplate/
├── .github/            # GitHub Actions workflows
├── app/                # Application logic
│   ├── Features/       # Traits and functionalities
│   ├── Hooks/          # WordPress hooks
│   ├── Services/       # Services and DB interactions
│   └── App.php         # Main initializer
├── config/             # Configurations
│   ├── environments/   # Environment variables
│   ├── application.php # Base config
│   └── webpack.*.js    # Webpack configurations
├── resources/          # Assets and templates
│   ├── blocks/         # Custom blocks
│   ├── scripts/        # JS entry points
│   ├── scss/           # Global styles
│   └── views/          # Twig templates
├── web/                # Web root
│   ├── content/        # WP content directory
│   └── wp/             # Core WordPress
└── [config files]      # Global configurations

Development

Main Commands

# Install dependencies
pnpm install

# Development with hot-reload
pnpm run dev

# Production build
pnpm run build

# Lint PHP
pnpm run lint

# Format code
pnpm run format

Block Creation

1. Add new block in resources/blocks/
2. Use WordPress registerBlockType
3. Import styles/scripts in Webpack config

Twig Templates

// Example usage in WordPress
View::render('template-name', ['data' => $values]);

GitHub Actions Workflow

• Lint: PHP/JS code verification
• Build: Asset compilation
• Deploy: Configurable for different environments

Coding Standards

• PHP: PHP-CS-Fixer (config in pint.json)
• JS: ESLint with standard config
• Styles: SCSS with SMACSS structure

Contribution

1. Fork the project
2. Create feature branch (feat/my-feature)
3. Submit Pull Request

License

GPL-3.0. See LICENSE for details.

Changelog

See CHANGELOG.md for version history.