globalis/wp-cubi

WordPress modern stack for developers

1.8.2 2023-05-22 12:16 UTC

Requires

• php: >=8.0 <8.3
• composer/installers: ^2.1.1
• globalis/wp-cli-bin: ^2.7.1
• globalis/wp-cubi-helpers: ^1.0.5
• globalis/wp-cubi-imagemin: ^1.3.2
• globalis/wp-cubi-transient-cache: ^0.3.0
• globalis/wp-unhooked: ^1.0.2
• inpsyde/wonolog: ^2.x-dev
• johnbillion/extended-cpts: ^5.0.3
• roots/soil: ^4.1.1
• roots/wordpress: 6.2.2
• roots/wp-password-bcrypt: ^1.1.0
• wpackagist-plugin/autodescription: ^4.2.8
• wpackagist-plugin/dynamo: ^1.1
• wpackagist-plugin/limit-login-attempts-reloaded: ^2.25.13
• wpackagist-plugin/query-monitor: ^3.12.1
• wpackagist-plugin/user-switching: ^1.7.0
• wpackagist-plugin/wp-crontrol: ^1.15.2

Requires (Dev)

• consolidation/robo: 3.x-dev@dev
• globalis/wp-cubi-robo: ^2.2.2
• squizlabs/php_codesniffer: ^3.7.2

Suggests

• globalis/wp-cubi-robo-globalis: Provides a BuildAssets trait for RoboFile

GPL-2.0-or-later

• Pierre Dargham
• GLOBALIS media systems

• composer
• wordpress
• stack
• wp
• robo
• wp-cubi
• globalis

README

WordPress modern stack for developers

Overview

wp-cubi provides a modern stack and project structure to make professional web applications with WordPress.

Built with Composer dependency manager and Robo task runner.

Features

• Environment-specific configuration
• Automated no-index and mail-trapper on development / staging environments
• Command-line administration with wp-cli
• Monitoring tools (query-monitor, wp-crontrol, user-switching, wp-cubi-admin-bar)
• Cleaner wp-admin with globalis/wp-unhooked
• Gitflow integration with Robo commands
• Optimized .htaccess generation
• Logging system with inpsyde/wonolog and monolog
• Standalone image minification plugin with globalis/wp-cubi-imagemin
• Additional functions with globalis/wp-cubi-helpers
• SEO friendly, with The SEO Framework plugin and roots/soil DOM optimizations
• Lighter and faster than a default WordPress application, by disabling things we don't use from core
• Comments disabled by default
• Automatically cache nav-menus with globalis/wp-cubi-transient-cache

Security optimizations

• Separated web root folder
• .htaccess security directives
• Deactivation of REST API and xmlrpc.php unless explicitly activated
• Better password encryption with roots/wp-password-bcrypt
• Anti brute-force protection on wp-login.php with Limit Login Attempts Reloaded

Requirements

• PHP >=8.0 <8.3
• Composer
• Git

Installation

1. Create a new project: composer create-project --remove-vcs globalis/wp-cubi your-project && cd your-project
2. Run installation command and answer the questions: ./vendor/bin/robo install --setup-wordpress
3. Access your new site administration: /wpcb/wp-admin/

Configuration

• Edit WP_UNHOOKED_CONFIG constant, according to your needs, in config/application.php
• Login page logo: Replace ./web/logo.png with your application logo (or edit 00-wp-cubi-core-mu/20-wp-login.php)
• If your application uses a SMTP server for outgoing emails, configure it in config/local.php
• Image minification: Configure globalis/wp-cubi-imagemin to enable a meaningfull level of uploads / image minification

Commands

wp-cli

• ./vendor/bin/wp <command> (see complete list)

Coding standards

• ./vendor/bin/phpcs [directory] : Check coding standards (see ./phpcs.xml)
• ./vendor/bin/phpcbf [directory] : Fix coding standards auto-fixable violations

Robo

• ./vendor/bin/robo install [--setup-wordpress]
• ./vendor/bin/robo configure
• ./vendor/bin/robo build
• ./vendor/bin/robo build:composer
• ./vendor/bin/robo build:config
• ./vendor/bin/robo build:htaccess
• ./vendor/bin/robo wp:language-install [<language>] [--activate]
• ./vendor/bin/robo wp:language-update [<language>] [--activate]
• ./vendor/bin/robo wp:update-timezone
• ./vendor/bin/robo feature:start <feature-name>
• ./vendor/bin/robo feature:finish <feature-name>
• ./vendor/bin/robo hotfix:start [--semversion=<version>]
• ./vendor/bin/robo hotfix:finish [--semversion=<version>]
• ./vendor/bin/robo release:start [--semversion=<version>]
• ./vendor/bin/robo release:finish [--semversion=<version>]
• ./vendor/bin/robo deploy <environment> <version> [--ignore-assets] [--ignore-composer]
• ./vendor/bin/robo deploy:setup <environment>
• ./vendor/bin/robo media:dump <environment> [--delete]
• ./vendor/bin/robo media:push <environment> [--delete]

WordPress plugins

wp-cubi handles WordPress plugin dependencies (including wordpress.org plugins) through Composer.

If you want to use plugins that are not available through wordpress.org or a public Composer repository, you have two options:

1. Simplest: Manually add the plugin in your ./web/app/modules/ directory, then whitelist it in your ./gitignore file
2. Recommanded: Create a private Composer repository to host your plugin

Logs

wp-cubi comes with inpsyde/wonolog, which allows to log anything with a single line of code, and automatically writes logs for multiple events like PHP errors, DB errors, HTTP API errors, wp_mail() errors, and more.

Basic configuration is possible in wp-cubi ./config/application.php and ./config/environments/ files, where you can change the maximum number of log files and the log level.

For advanced configuration (adding channels or handlers), you can edit ./web/app/mu-modules/00-wp-cubi-core-mu/src/00-wonolog.php (see inpsyde/wonolog documentation and monolog documentation)

Deploys

wp-cubi provides a basic deploy command ./vendor/bin/robo deploy that builds the application and deploys it with rsync.

You can build your own deploy method using Deployer, Capistrano or any other tool by editing ./RoboFile.php.

Where is the block editor gone ?

We use globalis/wp-unhooked to disable a lot of things from WordPress core, such as block editor, REST-API, xmlrpc, comments, most of dashboard widgets and a few admin menus entries.

It allows your application to be cleaner, faster and lighter. It also improves security, by disabling potential attack routes when you don't need them.

If you need to activate one of those things, edit WP_UNHOOKED_CONFIG constant in config/application.php.